|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.compoze.ebusiness.Recipients
This class implements a collection of recipients. A collection of recipients provides an way to add SMTP recipients and resolve the addresses of those recipients.
Recipient
, Serialized FormConstructor Summary | |
Recipients()
Constructor. |
Method Summary | |
void |
addSmtp(java.lang.String sAddress)
Adds the recipient in the collection as required |
void |
addSmtp(java.lang.String sAddress,
RecipientRole role)
Adds the recipient in the collection. |
int |
getCount()
Gets the number of recipients in the collection. |
Recipient |
getFirstUnresolved()
Gets the first unresolved recipient in the collection. |
Recipient |
getNextUnresolved()
Gets the next unresolved recipient in the collection. |
javax.mail.internet.InternetAddress[] |
getResolved()
Gets the resolved recipients in the collection. |
boolean |
isResolved()
Checks if the recepients are all resolved. |
java.util.List |
recipients()
Gets the list of recipients in the collection. |
java.util.List |
recipients(RecipientRole role)
Gets the list of recipients in the collection matching the specified role. |
void |
resolve()
Resolves all of the recipients in the collection. |
java.lang.String |
toString()
Returns the string representation of the object. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Recipients()
Method Detail |
public void addSmtp(java.lang.String sAddress)
sAddress
- the address of the repicient (for example, "somebody@somewhere.com")public void addSmtp(java.lang.String sAddress, RecipientRole role)
sAddress
- the address of the repicient (for example, "somebody@somewhere.com")role
- the role of the recipientpublic int getCount()
public java.util.List recipients()
Recipient
s in the collection (unmodifiable)public java.util.List recipients(RecipientRole role)
role
- the recipient role to match (may not be null
)Recipient
s in the collection (unmodifiable)public javax.mail.internet.InternetAddress[] getResolved()
public Recipient getFirstUnresolved()
null
if there are no unresolved recipientspublic Recipient getNextUnresolved()
null
if there are no more unresolved recipientspublic void resolve()
public boolean isResolved()
true
if the recipients are all resolved; false
otherwisepublic java.lang.String toString()
toString
in class java.lang.Object
|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |