nan.model
Class UserSettings

java.lang.Object
  extended bynan.model.UserSettings
All Implemented Interfaces:
Transposer, XMLSerializable

public class UserSettings
extends java.lang.Object
implements XMLSerializable, Transposer

The settings used by the user.

Version:
1.5, 1/2/04
Author:
John David Ratliff

Field Summary
static java.lang.String XML_EMAIL
          XML tag for the email setting.
static java.lang.String XML_NAME
          XML tag for the name setting.
static java.lang.String XML_SIGNATURE
          XML tag for the signature setting.
static java.lang.String XML_TAG
          The XML tag for serializing user settings.
 
Constructor Summary
UserSettings()
          Creates a new UserSettings object.
UserSettings(java.lang.String name, java.lang.String email, java.lang.String signature)
          Creates a new UserSettings object.
 
Method Summary
 boolean equals(java.lang.Object object)
          Tests if this UserSettings is logically equivalent to another object.
 java.lang.String getEmail()
          Gets the user's email.
 java.lang.String getName()
          Gets the user's name.
 java.lang.String getSignature()
          Gets the user's signature.
 void setEmail(java.lang.String email)
          Sets the user's email.
 void setName(java.lang.String name)
          Sets the user's name.
 void setSignature(java.lang.String signature)
          Sets the user's signature.
 java.lang.String toString()
          Gets a String representation of this UserSettings.
 org.dom4j.Document toXML()
          Converts this UserSettings object into an XML Document.
 void transpose(java.lang.Object object)
          Transposes (copies over) the values of another object of the same type onto this one.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

XML_TAG

public static final java.lang.String XML_TAG
The XML tag for serializing user settings.

See Also:
Constant Field Values

XML_NAME

public static final java.lang.String XML_NAME
XML tag for the name setting.

See Also:
Constant Field Values

XML_EMAIL

public static final java.lang.String XML_EMAIL
XML tag for the email setting.

See Also:
Constant Field Values

XML_SIGNATURE

public static final java.lang.String XML_SIGNATURE
XML tag for the signature setting.

See Also:
Constant Field Values
Constructor Detail

UserSettings

public UserSettings(java.lang.String name,
                    java.lang.String email,
                    java.lang.String signature)
Creates a new UserSettings object.

Parameters:
name - The name of the user.
email - The email of the user.
signature - The signature of the user.

UserSettings

public UserSettings()
Creates a new UserSettings object.

Method Detail

toXML

public org.dom4j.Document toXML()
Converts this UserSettings object into an XML Document.

Specified by:
toXML in interface XMLSerializable
Returns:
The XML Document.

getName

public java.lang.String getName()
Gets the user's name.

Returns:
The name.

setName

public void setName(java.lang.String name)
Sets the user's name.

Parameters:
name - The name.

getEmail

public java.lang.String getEmail()
Gets the user's email.

Returns:
The email.

setEmail

public void setEmail(java.lang.String email)
Sets the user's email.

Parameters:
email - The email.

getSignature

public java.lang.String getSignature()
Gets the user's signature.

Returns:
The signature.

setSignature

public void setSignature(java.lang.String signature)
Sets the user's signature.

Parameters:
signature - The signature.

equals

public boolean equals(java.lang.Object object)
Tests if this UserSettings is logically equivalent to another object.

Parameters:
object - The object to test equality with.
Returns:
true if ths two objects are equal; false otherwise.

transpose

public void transpose(java.lang.Object object)
Transposes (copies over) the values of another object of the same type onto this one. If the object is not the same type as the invoked object, it will be ignored.

Specified by:
transpose in interface Transposer
Parameters:
object - The object to transpose over this one.

toString

public java.lang.String toString()
Gets a String representation of this UserSettings.

Returns:
A String representation.