de.smartics.properties.impl.config.domain.key.rtaware
Class UserId

java.lang.Object
  de.smartics.properties.impl.config.domain.key.rtaware.UserId

All Implemented Interfaces:

Serializable, Comparable< UserId>

public final class UserId
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      Serializable, 
      
      Comparable<
      
      UserId>
     
     

Identifies an particular name of the system.

See Also:

Serialized Form

Field Summary

static UserId

ANY_USER Defines the ID for any user.

Constructor Summary

UserId(String name)
Default constructor.

Method Summary

int	compareTo(UserId o)
boolean	equals(Object object) Returns true if the given object is semantically equal to the given object, false otherwise.
String	getName() Returns the name of a name.
int	hashCode() Returns the hash code of the object.
String	toString() Returns the string representation of the object.
static UserId	valueOf(String userString) Returns an UserId for the given userString.

Methods inherited from class java.lang.Object

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

Field Detail

ANY_USER

public static final UserId ANY_USER

Defines the ID for any user.

Constructor Detail

UserId

public UserId(String name)

Default constructor.

Parameters:

name - the name of a name.

Method Detail

getName

@CheckForNull
public String getName()

Returns the name of a name. May be null.

Returns:

the name of a name.

compareTo

public int compareTo(UserId o)

Specified by:

compareTo in interface Comparable<UserId>

hashCode

public int hashCode()

Returns the hash code of the object.

Overrides:

hashCode in class Object

Returns:

the hash code.

equals

public boolean equals(Object object)

Returns true if the given object is semantically equal to the given object, false otherwise.

Overrides:

equals in class Object

Parameters:

object - the instance to compare to.

Returns:

true if the given object is semantically equal to the given object, false otherwise.

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Object

Returns:

the string representation of the object.

valueOf

public static UserId valueOf(String userString)

Returns an UserId for the given userString.

Parameters:

userString - a string describing an userId.

Returns:

an userId for the given String.