Rfc822Token
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 | |
---|---|
Public constructors
Rfc822Token
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
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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
public String getAddress ()
Returns the address part.
Returns | |
---|---|
String |
This value may be null . |
getComment
public String getComment ()
Returns the comment part.
Returns | |
---|---|
String |
This value may be null . |
getName
public String getName ()
Returns the name part.
Returns | |
---|---|
String |
This value may be null . |
hashCode
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 inequals
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 thehashCode
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 thehashCode
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
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
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
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
public void setAddress (String address)
Changes the address to the specified address.
Parameters | |
---|---|
address |
String : This value may be null . |
setComment
public void setComment (String comment)
Changes the comment to the specified comment.
Parameters | |
---|---|
comment |
String : This value may be null . |
setName
public void setName (String name)
Changes the name to the specified name.
Parameters | |
---|---|
name |
String : This value may be null . |
toString
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. |