com.io7m.jfprop

Class JFPUserName

java.lang.Object

com.io7m.jfprop.JFPUserName

All Implemented Interfaces:

Serializable, Comparable<JFPUserName>

public final class JFPUserName
extends Object
implements Serializable, Comparable<JFPUserName>

The type of valid user names.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JFPUserName(String in_actual) Construct a name, raising JFPExceptionAuthentication if the name is not valid according to validName(String).

Method Summary

Modifier and Type	Method and Description
int	compareTo(JFPUserName o)
boolean	equals(Object obj)
String	getActual()
int	hashCode()
String	toString()
static boolean	validName(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

JFPUserName

public JFPUserName(String in_actual)
            throws JFPExceptionAuthentication

Construct a name, raising JFPExceptionAuthentication if the name is not valid according to validName(String).

Parameters:

in_actual - The actual name.

Throws:

JFPExceptionAuthentication - On invalid names.

Method Detail

validName

public static boolean validName(String name)

Parameters:

name - The name.

Returns:

true iff length(name) > 0 ∧ ∀i. isLetter(name(i)) ∨ isDigit(name(i)) ∨ name(i) = '_' .

compareTo

public int compareTo(@Nullable
                     JFPUserName o)

Specified by:

compareTo in interface Comparable<JFPUserName>

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

getActual

public String getActual()

Returns:

The actual name as a string.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object