SHOW Signed

net.rim.blackberry.api.mail
Class Address

java.lang.Object
  |
  +--net.rim.blackberry.api.mail.Address
Direct Known Subclasses:
PINAddress

public class Address
extends Object

Represents an address in a message.

This includes addresses in the message header fields, such as the sender and recipient, as well as in the message body.

Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:
JDE 3.6.0
See Also:
Message

Field Summary
 Category: Signed static String EMAIL_ADDR
          Prefix string for email addresses.
 Category: Signed static String FTP_ADDR
          Represents the prefix string for FTP addresses.
 Category: Signed static String HTTP_ADDR
          Represents the prefix string for HTTP addresses.
 Category: Signed static String WAP_ADDR
          Represents the prefix string for WAP addresses.
 
Constructor Summary
 Category: Signed Address(String addr, String name)
          Creates a new Address instance with provided address and name.
 
Method Summary
 Category: Signed  boolean equals(Object o)
          Compares this address with provided object.
 Category: Signed  String get_type()
          Retrieves this address's type.
 Category: Signed  String getAddr()
          Retrieves this address's fully qualified address string.
 Category: Signed  String getName()
          Retrieves this address's display name.
 Category: Signed  int hashCode()
          Retrieves a hash for this address.
 Category: Signed  String toString()
          Produces string form of this address.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail


EMAIL_ADDR

public static String EMAIL_ADDR
Prefix string for email addresses.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

FTP_ADDR

public static String FTP_ADDR
Represents the prefix string for FTP addresses.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

HTTP_ADDR

public static String HTTP_ADDR
Represents the prefix string for HTTP addresses.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

WAP_ADDR

public static String WAP_ADDR
Represents the prefix string for WAP addresses.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Constructor Detail

Address

public Address(String addr,
               String name)
        throws AddressException
Creates a new Address instance with provided address and name.

This constructor sets the address type to EMAIL_ADDR.

Parameters:
addr - Address string, such as "rbarnes@company.com".
name - Address display name, such as "Rob Barnes".
Throws:
AddressException - If you provide an invalid address.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Method Detail

equals

public boolean equals(Object o)
Compares this address with provided object.
Overrides:
equals in class Object
Parameters:
o - An object to compare to this address.
Returns:
True if provided object is the same object as this address, or if the provided object has the same type, address, and name data; otherwise, false.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

get_type

public String get_type()
Retrieves this address's type.
Returns:
Type of address.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getAddr

public String getAddr()
Retrieves this address's fully qualified address string.
Returns:
Fully qualified address string.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getName

public String getName()
Retrieves this address's display name.
Returns:
Display name for this address.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

hashCode

public int hashCode()
Retrieves a hash for this address.
Overrides:
hashCode in class Object
Returns:
Hash of this object's data.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

toString

public String toString()
Produces string form of this address.

This method produces a string of the form type:address.

Overrides:
toString in class Object
Returns:
String form of this address; for example, "mailto:johndoe@company.com".
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.


Copyright 1999-2007 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.