Android APIs
public class

Rfc822Token

extends Object
java.lang.Object
   ↳ android.text.util.Rfc822Token

Class Overview

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

Summary

Public Constructors
Rfc822Token(String name, String address, String comment)
Creates a new Rfc822Token with the specified name, address, and comment.
Public Methods
boolean equals(Object o)
Compares this instance with the specified object and indicates if they are equal.
String getAddress()
Returns the address part.
String getComment()
Returns the comment part.
String getName()
Returns the name part.
int hashCode()
Returns an integer hash code for this object.
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).
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

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

Added in API level 1

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

Parameters
name String
address String
comment String

Public Methods

public boolean equals (Object o)

Added in API level 1

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
o Object: the object to compare this instance with.
Returns
boolean true if the specified object is equal to this Object; false otherwise.

public String getAddress ()

Added in API level 1

Returns the address part.

Returns
String

public String getComment ()

Added in API level 1

Returns the comment part.

Returns
String

public String getName ()

Added in API level 1

Returns the name part.

Returns
String

public int hashCode ()

Added in API level 1

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
int this object's hash code.

public static String quoteComment (String comment)

Added in API level 1

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

Parameters
comment String
Returns
String

public static String quoteName (String name)

Added in API level 1

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 String
Returns
String

public static String quoteNameIfNecessary (String name)

Added in API level 1

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 String
Returns
String

public void setAddress (String address)

Added in API level 1

Changes the address to the specified address.

Parameters
address String

public void setComment (String comment)

Added in API level 1

Changes the comment to the specified comment.

Parameters
comment String

public void setName (String name)

Added in API level 1

Changes the name to the specified name.

Parameters
name String

public String toString ()

Added in API level 1

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.

Returns
String a printable representation of this object.