Top Description Fields Constructors Methods
org.apache.tools.ant.taskdefs.email

public Class EmailAddress

extends Object
Class Inheritance

Holds an email address.
Since
Ant 1.5

Field Summary

Modifier and TypeField and Description
private String
private String

Constructor Summary

AccessConstructor and Description
public
EmailAddress()

Creates an empty email address

public
EmailAddress(String
the email address (with or without <>) Acceptable forms include: address <address> name <address> <address> name (name) address address (name)
email
)

Creates a new email address based on the given string

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the address part
getAddress
()

Returns the address

public String

Returns:

the display name part
getName
()

Returns the display name

public void
setAddress(String
the actual email address (without <>)
address
)

Sets the email address.

public void
setName(String
the display name
name
)

Sets the personal / display name of the address.

public String

Returns:

a string representation of the address
toString
()

Overrides java.lang.Object.toString.

Constructs a string "name <address>" or "address"
private String
trim(String t, boolean trimAngleBrackets)

A specialised trim() that trims whitespace, '(', ')', '"', '<', '>' from the start and end of strings

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

addressback to summary
private String address
nameback to summary
private String name

Constructor Detail

EmailAddressback to summary
public EmailAddress()

Creates an empty email address

EmailAddressback to summary
public EmailAddress(String email)

Creates a new email address based on the given string

Parameters
email:String

the email address (with or without <>) Acceptable forms include: address <address> name <address> <address> name (name) address address (name)

Method Detail

getAddressback to summary
public String getAddress()

Returns the address

Returns:String

the address part

getNameback to summary
public String getName()

Returns the display name

Returns:String

the display name part

setAddressback to summary
public void setAddress(String address)

Sets the email address.

Parameters
address:String

the actual email address (without <>)

setNameback to summary
public void setName(String name)

Sets the personal / display name of the address.

Parameters
name:String

the display name

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Constructs a string "name <address>" or "address"

Returns:String

a string representation of the address

Annotations
@Override
trimback to summary
private String trim(String t, boolean trimAngleBrackets)

A specialised trim() that trims whitespace, '(', ')', '"', '<', '>' from the start and end of strings