Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.account

Class Account.Name

java.lang.Object

com.aoindustries.aoserv.client.account.Account.Name

All Implemented Interfaces:

DtoFactory<AccountName>, FastExternalizable, Internable<Account.Name>, Externalizable, Serializable, Comparable<Account.Name>

Enclosing class:

Account

public static final class Account.Name
extends Object
implements Comparable<Account.Name>, FastExternalizable, DtoFactory<AccountName>, Internable<Account.Name>

The unique, case-insensitive identifier for an Account. Account names must:

• Be non-null
• Be non-empty
• Be between 2 and 32 characters
• Must start with [a-z,A-Z]
• Must end with [a-z,A-Z,0-9]
• Must contain only [a-z,A-Z,0-9,_]
• May not have consecutive underscores

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_LENGTH
static final int	MIN_LENGTH

Constructor Summary

Constructors

Constructor	Description
Name()	Deprecated. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Account.Name other)
boolean	equals(Object obj)
AccountName	getDto()
long	getSerialVersionUID()
int	hashCode()
Account.Name	intern()	Interns this name much in the same fashion as String.intern().
void	readExternal(ObjectInput in)
String	toString()
String	toUpperCase()	Gets the upper-case form of the code.
static ValidationResult	validate(String name)	Validates a name.
static Account.Name	valueOf(String name)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Details

MIN_LENGTH

public static final int MIN_LENGTH

See Also:

• Constant Field Values

MAX_LENGTH

public static final int MAX_LENGTH

See Also:

• Constant Field Values

Constructor Details

Name

@Deprecated(forRemoval=false)
public Name()

Deprecated.

Only required for implementation, do not use directly.

See Also:

• FastExternalizable

Method Details

validate

public static ValidationResult validate(String name)

Validates a name.

valueOf

public static Account.Name valueOf(String name)
                            throws ValidationException

Parameters:

name - when null, returns null

Throws:

ValidationException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Account.Name other)

Specified by:

compareTo in interface Comparable<Account.Name>

toString

public String toString()

Overrides:

toString in class Object

toUpperCase

public String toUpperCase()

Gets the upper-case form of the code. If two different names are interned and their toUpperCase is the same String instance, then they are equal in case-insensitive manner.

intern

public Account.Name intern()

Interns this name much in the same fashion as String.intern().

Specified by:

intern in interface Internable<Account.Name>

See Also:

• String.intern()

getDto

public AccountName getDto()

Specified by:

getDto in interface DtoFactory<AccountName>

getSerialVersionUID

public long getSerialVersionUID()

Specified by:

getSerialVersionUID in interface FastExternalizable

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException