com.whitestein.lsps.orgstructure.entity

Class RoleName

java.lang.Object

com.whitestein.lsps.orgstructure.entity.RoleName

All Implemented Interfaces:

EntityWithId<java.lang.String>

@Entity
public class RoleName
extends java.lang.Object
implements EntityWithId<java.lang.String>

Persistent entity representing a name of a role.

Since:

1.2

Author:

vgr

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIND_ALL Query name.
static int	MAX_PARAMS Maximum number of parameters a role name can have.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RoleName() Constructor needed for JPA-specific purposes.
	RoleName(java.lang.String moduleName, java.lang.String localName) Constructs new RoleName instance specified by given localName.
	RoleName(java.lang.String moduleName, java.lang.String localName, java.util.Collection<java.lang.String> parameterNames) Constructs new RoleName instance specified by given localName.

Method Summary

Modifier and Type	Method and Description
RoleName	addParameterName(java.lang.String parameterName) Adds new parameter name to this RoleName and returns the current RoleName instance.
boolean	containsParameterName(java.lang.String name) Returns true if the parameter names contain given name.
boolean	equals(java.lang.Object obj)
RoleUnitName	getFullName(RoleUnitParameter... parameters) Returns the RoleUnitName corresponding to this RoleName for given parameters.
java.lang.String	getId() Returns the primary key.
java.lang.String	getLocalName() Returns the local name of this RoleName instance.
java.lang.String	getModuleName() Returns the module name.
RoleUnitName	getName() Returns the role name.
RoleUnitName	getNameWithParameters() Returns the role name with all parameter names having null values.
java.lang.Integer	getParameterIndex(java.lang.String parameterName) Returns the index of the given parameter.
java.util.Map<java.lang.String,java.lang.Integer>	getParameterIndices() Returns a map of parameter indices.
java.lang.String	getParameterName(int idx) Returns the parameter name for the given index.
java.util.Collection<java.lang.String>	getParameterNames() Returns a set of all the parameter names that belong to this role name.
java.lang.String	getStringName() Returns the role name as string (module name + '::' + local name)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FIND_ALL

public static final java.lang.String FIND_ALL

Query name.

See Also:

Constant Field Values

MAX_PARAMS

public static final int MAX_PARAMS

Maximum number of parameters a role name can have.

See Also:

Constant Field Values

Constructor Detail

RoleName

protected RoleName()

Constructor needed for JPA-specific purposes.

RoleName

public RoleName(java.lang.String moduleName,
                java.lang.String localName)

Constructs new RoleName instance specified by given localName.

Parameters:

moduleName - the role module name

localName - the role local name

Throws:

java.lang.NullPointerException - if moduleName or localName is null

RoleName

public RoleName(java.lang.String moduleName,
                java.lang.String localName,
                java.util.Collection<java.lang.String> parameterNames)

Constructs new RoleName instance specified by given localName.

Parameters:

moduleName - the role module name

localName - the role local name

parameterNames - the role parameter names

Throws:

java.lang.NullPointerException - if moduleName or localName or parameterNames is null

Method Detail

getName

public RoleUnitName getName()

Returns the role name.

Returns:

the role name

getId

public java.lang.String getId()

Description copied from interface: EntityWithId

Returns the primary key.

Specified by:

getId in interface EntityWithId<java.lang.String>

Returns:

the primary key

getNameWithParameters

public RoleUnitName getNameWithParameters()

Returns the role name with all parameter names having null values.

Returns:

the role name with all parameter names having null values

getStringName

public java.lang.String getStringName()

Returns the role name as string (module name + '::' + local name)

Returns:

the role name as string (module name + '::' + local name)

getModuleName

public java.lang.String getModuleName()

Returns the module name.

Returns:

the module name

getLocalName

public java.lang.String getLocalName()

Returns the local name of this RoleName instance.

Returns:

The local name of this RoleName instance.

getParameterNames

public java.util.Collection<java.lang.String> getParameterNames()

Returns a set of all the parameter names that belong to this role name.

Returns:

A collection of all the parameter names that belong to this RoleName instance.

containsParameterName

public boolean containsParameterName(java.lang.String name)

Returns true if the parameter names contain given name.

Parameters:

name - the parameter name

Returns:

true if the parameter names contain given name

addParameterName

public RoleName addParameterName(java.lang.String parameterName)

Adds new parameter name to this RoleName and returns the current RoleName instance.

Parameters:

parameterName - The name of the parameter name to add to this role name.

Returns:

Current RoleName instance.

Throws:

java.lang.NullPointerException - (unchecked) If the parameterName argument is null.

java.lang.IllegalStateException - (unchecked) If the parameter name identified by given parameterName argument already exists in this role name or the current parameter name count is already MAX_PARAMS.

getParameterIndices

public java.util.Map<java.lang.String,java.lang.Integer> getParameterIndices()

Returns a map of parameter indices.

Returns:

a map of parameter indices

getParameterIndex

public java.lang.Integer getParameterIndex(java.lang.String parameterName)

Returns the index of the given parameter.

Parameters:

parameterName - the parameter name

Returns:

the index of the given parameter

getParameterName

public java.lang.String getParameterName(int idx)

Returns the parameter name for the given index.

Parameters:

idx - the parameter index

Returns:

the parameter name for the given index

Throws:

java.lang.IndexOutOfBoundsException - if the given index is out of bounds

getFullName

public RoleUnitName getFullName(RoleUnitParameter... parameters)

Returns the RoleUnitName corresponding to this RoleName for given parameters.

Parameters:

parameters - the array of parameters

Returns:

the RoleUnitName corresponding to this RoleName for given parameters

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object