Added in API level 1

Summary: Ctors | Methods | Inherited Methods

Rfc822Token

Kotlin |Java

public class Rfc822Token
extends Object

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

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)` Indicates whether some other object is "equal to" this one.
`String`	`getAddress()` Returns the address part.
`String`	`getComment()` Returns the comment part.
`String`	`getName()` Returns the name part.
`int`	`hashCode()` Returns a hash code value for the 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).

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Rfc822Token

Added in API level 1

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

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

Parameters
`name`	`String`: This value may be `null`.
`address`	`String`: This value may be `null`.
`comment`	`String`: This value may be `null`.

Public methods

equals

Added in API level 1

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`o`	`Object`: This value may be `null`.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getAddress

Added in API level 1

public String getAddress ()

Returns the address part.

Returns
`String`	This value may be `null`.

getComment

Added in API level 1

public String getComment ()

Returns the comment part.

Returns
`String`	This value may be `null`.

getName

Added in API level 1

public String getName ()

Returns the name part.

Returns
`String`	This value may be `null`.

hashCode

Added in API level 1

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
`int`	a hash code value for this object.

quoteComment

Added in API level 1

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

Returns
`String`

quoteName

Added in API level 1

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

Returns
`String`

quoteNameIfNecessary

Added in API level 1

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

Returns
`String`

setAddress

Added in API level 1

public void setAddress (String address)

Changes the address to the specified address.

Parameters
`address`	`String`: This value may be `null`.

setComment

Added in API level 1

public void setComment (String comment)

Changes the comment to the specified comment.

Parameters
`comment`	`String`: This value may be `null`.

setName

Added in API level 1

public void setName (String name)

Changes the name to the specified name.

Parameters
`name`	`String`: This value may be `null`.

toString

Added in API level 1

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.

Returns
`String`	a string representation of the object.