org.fuin.objects4j
Class UserName

java.lang.Object
  org.fuin.objects4j.UserName

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UserName>

@Immutable
public final class UserName
extends java.lang.Object
implements java.lang.Comparable<UserName>, java.io.Serializable

User name with the following rules.

• 3-20 characters in length
• Lower case letters (a-z)
• Numbers (0-9)
• Hyphens (-)
• Underscores (_)
• Starts not with an underscore, hyphen or number

See Also:

Serialized Form

Constructor Summary

UserName(java.lang.String userName)
Constructor with user name.

Method Summary

int	compareTo(UserName obj)
boolean	equals(java.lang.Object obj)
int	hashCode()
int	length() Returns the length of the user id.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserName

@Requires(value="(userName!=null) && ValidUserNameValidator.isValid(userName)")
public UserName(java.lang.String userName)

Constructor with user name.

Parameters:

userName - User name.

Method Detail

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

length

public final int length()

Returns the length of the user id.

Returns:

Number of characters.

compareTo

public final int compareTo(UserName obj)

Specified by:

compareTo in interface java.lang.Comparable<UserName>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object