Rfc822Token

public class Rfc822Token extends Object

This class stores an RFC 822-like name, address, and comment, and provides methods to convert them to quoted strings.

Public Constructor Summary

Rfc822Token(String name, String address, String comment)
Creates a new Rfc822Token with the specified name, address, and comment.

Public Method Summary

boolean
equals(Object o)
String
getAddress()
Returns the address part.
String
getComment()
Returns the comment part.
String
getName()
Returns the name part.
int
static String
quoteComment(String comment)
Returns the comment, with internal backslashes and parentheses preceded by backslashes.
static String
quoteName(String name)
Returns the name, with internal backslashes and quotation marks preceded by backslashes.
static String
quoteNameIfNecessary(String name)
Returns the name, conservatively quoting it if there are any characters that are likely to cause trouble outside of a quoted string, or returning it literally if it seems safe.
void
setAddress(String address)
Changes the address to the specified address.
void
setComment(String comment)
Changes the comment to the specified comment.
void
setName(String name)
Changes the name to the specified name.
String
toString()
Returns the name (with quoting added if necessary), the comment (in parentheses), and the address (in angle brackets).

Inherited Method Summary

Public Constructors

public Rfc822Token (String name, String address, String comment)

Creates a new Rfc822Token with the specified name, address, and comment.

Parameters
name
address
comment

Public Methods

public boolean equals (Object o)

Parameters
o

public String getAddress ()

Returns the address part.

public String getComment ()

Returns the comment part.

public String getName ()

Returns the name part.

public int hashCode ()

public static String quoteComment (String comment)

Returns the comment, with internal backslashes and parentheses preceded by backslashes. The outer parentheses themselves are not added by this method.

Parameters
comment

public static String quoteName (String name)

Returns the name, with internal backslashes and quotation marks preceded by backslashes. The outer quote marks themselves are not added by this method.

Parameters
name

public static String quoteNameIfNecessary (String name)

Returns the name, conservatively quoting it if there are any characters that are likely to cause trouble outside of a quoted string, or returning it literally if it seems safe.

Parameters
name

public void setAddress (String address)

Changes the address to the specified address.

Parameters
address

public void setComment (String comment)

Changes the comment to the specified comment.

Parameters
comment

public void setName (String name)

Changes the name to the specified name.

Parameters
name

public String toString ()

Returns the name (with quoting added if necessary), the comment (in parentheses), and the address (in angle brackets). This should be suitable for inclusion in an RFC 822 address list.