javax.mail.internet

Class NewsAddress

Implemented Interfaces:
Serializable

public class NewsAddress
extends Address

This class models an RFC1036 newsgroup address.

Field Summary

protected String
host
The host name of the news server.
protected String
newsgroup
The name of the newsgroup.

Constructor Summary

NewsAddress()
Default constructor.
NewsAddress(String newsgroup)
Construct a NewsAddress with the given newsgroup.
NewsAddress(String newsgroup, String host)
Construct a NewsAddress with the given newsgroup and host.

Method Summary

boolean
equals(Object a)
The equality operator.
String
getHost()
Get the host.
String
getNewsgroup()
Get the newsgroup.
String
getType()
Return the type of this address.
int
hashCode()
Compute a hash code for the address.
static NewsAddress[]
parse(String newsgroups)
Parse the given comma separated sequence of newsgroups into NewsAddress objects.
void
setHost(String host)
Set the host.
void
setNewsgroup(String newsgroup)
Set the newsgroup.
String
toString()
Convert this address into a RFC 1036 address.
static String
toString(Address[] addresses)
Convert the given array of NewsAddress objects into a comma separated sequence of address strings.

Methods inherited from class javax.mail.Address

equals, getType, toString

Field Details

host

protected String host
The host name of the news server.


newsgroup

protected String newsgroup
The name of the newsgroup.

Constructor Details

NewsAddress

public NewsAddress()
Default constructor.


NewsAddress

public NewsAddress(String newsgroup)
Construct a NewsAddress with the given newsgroup.

Parameters:
newsgroup - the newsgroup


NewsAddress

public NewsAddress(String newsgroup,
                   String host)
Construct a NewsAddress with the given newsgroup and host.

Parameters:
newsgroup - the newsgroup
host - the host

Method Details

equals

public boolean equals(Object a)
The equality operator.
Overrides:
equals in interface Address


getHost

public String getHost()
Get the host.


getNewsgroup

public String getNewsgroup()
Get the newsgroup.


getType

public String getType()
Return the type of this address. The type of a NewsAddress is "news".
Overrides:
getType in interface Address


hashCode

public int hashCode()
Compute a hash code for the address.


parse

public static NewsAddress[] parse(String newsgroups)
            throws AddressException
Parse the given comma separated sequence of newsgroups into NewsAddress objects.

Parameters:
newsgroups - comma separated newsgroup string

Returns:
array of NewsAddress objects

Throws:
AddressException - if the parse failed


setHost

public void setHost(String host)
Set the host.

Parameters:
host - the host


setNewsgroup

public void setNewsgroup(String newsgroup)
Set the newsgroup.

Parameters:
newsgroup - the newsgroup


toString

public String toString()
Convert this address into a RFC 1036 address.
Overrides:
toString in interface Address


toString

public static String toString(Address[] addresses)
Convert the given array of NewsAddress objects into a comma separated sequence of address strings. The resulting string contains only US-ASCII characters, and hence is mail-safe.

Parameters:
addresses - array of NewsAddress objects

Returns:
comma separated address strings