org.josef.util

Class MailServer

java.lang.Object

org.josef.util.MailServer

All Implemented Interfaces:

Comparable<MailServer>

public class MailServer
extends Object
implements Comparable<MailServer>

Abstraction of a mail server as fetched from a DNS MX (Mail eXchange) record.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
MailServer(int preference, String domainName) Constructs this MailServer from the supplied preference and domainName.

Method Summary

Modifier and Type	Method and Description
int	compareTo(MailServer otherMailServer) Compares MailServers by preference and then by domain name.
boolean	equals(Object object) Determines whether this object is equal to the supplied Object.
String	getDomainName() Gets the domain name of this MailServer.
int	getPreference() Gets the preference of this MailServer.
int	hashCode() Computes the hash code of this MailServer.
String	toString() Creates a String representation of this MailServer.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MailServer

public MailServer(int preference,
                  String domainName)

Constructs this MailServer from the supplied preference and domainName.

Parameters:

preference - The preference of this mail server.

domainName - The domain name of this mail server.

Throws:

NullPointerException - When the supplied domainName is null.

IllegalArgumentException - When the supplied domainName is empty.

Method Detail

getPreference

public int getPreference()

Gets the preference of this MailServer.

Returns:

The preference of this MailServer.
The lower this number, the higher the preference.

getDomainName

public String getDomainName()

Gets the domain name of this MailServer.

Returns:

The domain name of this MailServer.

compareTo

public int compareTo(MailServer otherMailServer)

Compares MailServers by preference and then by domain name.

Specified by:

compareTo in interface Comparable<MailServer>

Parameters:

otherMailServer - The MailServer to compare to this MailServer.

Returns:

a negative number when this value < other value, 0 when both values are equal and a positive number when this value > other value.
Technically we'll return the difference in preference between this mail server and the other mail server. In case this difference is 0, the result of comparing this domain name to the other domain name is returned.

equals

public boolean equals(Object object)

Determines whether this object is equal to the supplied Object.
Both Objects are equal when:

• The supplied object is of type MailServer
• Both preference and domain name are equal

Overrides:

equals in class Object

Parameters:

object - The Object to compare to.
Objects not of type MailServer will never be equal.

Returns:

True when both Objects are equal, false otherwise.

hashCode

public int hashCode()

Computes the hash code of this MailServer.

Overrides:

hashCode in class Object

Returns:

Hash code of this Object.

toString

public String toString()

Creates a String representation of this MailServer.
The format is the one used in an actual MX (Mail eXchange) record, thus: preference space domain-name point.

Overrides:

toString in class Object

Returns:

A String representation of this MailServer.