org.fuin.objects4j
Class UserId

java.lang.Object
  org.fuin.objects4j.UserId

All Implemented Interfaces:

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

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

UserId 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

UserId(java.lang.String userId)
Constructor with userId.

Method Summary

int	compareTo(UserId 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

UserId

@Requires(value="(userId!=null) && ValidUserIdValidator.isValid(userId)")
public UserId(java.lang.String userId)

Constructor with userId.

Parameters:

userId - UserId.

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(UserId obj)

Specified by:

compareTo in interface java.lang.Comparable<UserId>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object