com.whitestein.lsps.os.dto

Class RoleUnitName

java.lang.Object

com.whitestein.lsps.os.dto.RoleUnitName

All Implemented Interfaces:

Serializable

public class RoleUnitName
extends Object
implements Serializable

Represents the name of a role and/or an organization unit (generally called RoleUnit name). Main purpose of this class is to ease the work with roles and organization units on all levels of abstraction (or all application layers).

A RoleUnit name consists of a module name, the separator (currently "::" without the quotes), and a local role or organization unit name. Its full form has the format " moduleName::localName" (without the quotes).

From the version 1.2 the class can have zero or more parameters (and as such, it can represent both a RoleUnit name and a parametric role or organization unit itself). Each parameter is composed of its name and its value.

Since:

1.1

Author:

vgr, rba

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEPARATOR The string separator of a module name and a local name.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RoleUnitName() Creates new instance.

Method Summary

Modifier and Type	Method and Description
void	afterUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent)
void	beforeUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent)
boolean	equals(Object object)
String	getLocalName() Returns the local name of this role or organization unit, i.e.
String	getModuleName() Returns the module name of this role or organization unit.
String	getName() Returns the simple name (i.e.
String	getNameWithParameters() Returns the full name (i.e.
String	getParameter(String name) Returns the value of a parameter identified by given name or null if the parameter with such name does not exist for this role or organization unit.
Set<String>	getParameterNames() Returns a set of parameter names present in this RoleUnitName.
List<RoleUnitParameter>	getParameters() Returns a collection of parameters.
Map<String,String>	getParametersMap() Returns a map of parameter names and values of this RoleUnitName .
int	hashCode()
boolean	isSubRole(RoleUnitName other) Returns true if this role is a sub-role of the other role, i.e.
boolean	matches(Collection<RoleUnitName> others) Returns true if this role matches at least one of the other roles.
static boolean	matches(Collection<RoleUnitName> roles1, Collection<RoleUnitName> roles2) Returns true if at least one role in roles1 matches at least one role in roles2.
boolean	matches(RoleUnitName other) Returns true if this role matches the other role, i.e.
static Set<RoleUnitName>	removeSubRoles(Collection<RoleUnitName> roles) Returns a set of RoleUnitNames with all sub-roles removed.
String	toString()
static RoleUnitName	valueOf(String fullName) Constructs a RoleUnit name using given raw string.
static RoleUnitName	valueOf(String name, Collection<RoleUnitParameter> parameters) Constructs a RoleUnit name using the full name of a role or an organization unit (i.e.
static RoleUnitName	valueOf(String name, RoleUnitParameter... parameters) Constructs a RoleUnit name using the full name of a role or an organization unit (i.e.
static RoleUnitName	valueOf(String moduleName, String localName, Collection<RoleUnitParameter> parameters) Constructs a RoleUnit name using the module name and the local name of a role or an organization unit.
static RoleUnitName	valueOf(String moduleName, String localName, RoleUnitParameter... parameters) Constructs a RoleUnit name using the module name and the local name of a role or an organization unit.
RoleUnitName	withParameterNames(Collection<String> paramNames) Returns this role unit name rebased using the specified parameter names.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final String SEPARATOR

The string separator of a module name and a local name.

See Also:

Constant Field Values

Constructor Detail

RoleUnitName

protected RoleUnitName()

Creates new instance.

Method Detail

valueOf

public static RoleUnitName valueOf(String fullName)

Constructs a RoleUnit name using given raw string.

Parameters:

fullName - a raw string that can contain either simple RoleUnit name (a module name, the separator, and a local name) or RoleUnit name together with all the parameters it has

Returns:

a RoleUnit from String

Throws:

NullPointerException - if fullName is null

IllegalArgumentException - if fullName has an invalid format

valueOf

public static RoleUnitName valueOf(String name,
                                   RoleUnitParameter... parameters)

Constructs a RoleUnit name using the full name of a role or an organization unit (i.e. the name with a module name, the separator, and a local name). Optionally the constructor takes a vararg array of parameters.

Parameters:

name - a full name of a role or an organization unit

parameters - an array of parameters of a role or an organization unit

Returns:

a RoleUnit

Throws:

NullPointerException - if name is null or any parameter in parameters is null

IllegalArgumentException - if name has an invalid format or any parameter in parameters is invalid or there are duplicate parameters

valueOf

public static RoleUnitName valueOf(String name,
                                   Collection<RoleUnitParameter> parameters)

Constructs a RoleUnit name using the full name of a role or an organization unit (i.e. the name with a module name, the separator, and a local name). The constructor takes a collection of parameters.

Parameters:

name - a full name of a role or an organization unit

parameters - a collection of parameters of a role or an organization unit

Returns:

a RoleUnit

Throws:

NullPointerException - if name is null or parameters or any parameter in parameters is null

IllegalArgumentException - if name has an invalid format or any parameter in parameters is invalid or there are duplicate parameters

valueOf

public static RoleUnitName valueOf(String moduleName,
                                   String localName,
                                   RoleUnitParameter... parameters)

Constructs a RoleUnit name using the module name and the local name of a role or an organization unit. Optionally the constructor takes a vararg array of parameters.

Parameters:

moduleName - a name of a module that contains a role or an organization unit

localName - a local name of a role or an organization unit

parameters - an array of parameters of a role or an organization unit

Returns:

a RoleUnit

Throws:

NullPointerException - if moduleName or localName or any of parameters is null

IllegalArgumentException - if name has an invalid format or any parameter in parameters is invalid or there are duplicate parameters

valueOf

public static RoleUnitName valueOf(String moduleName,
                                   String localName,
                                   Collection<RoleUnitParameter> parameters)

Constructs a RoleUnit name using the module name and the local name of a role or an organization unit. Optionally the constructor takes a vararg array of parameters.

Parameters:

moduleName - a name of a module that contains a role or an organization unit

localName - a local name of a role or an organization unit

parameters - an array of parameters of a role or an organization unit

Returns:

a RoleUnit

Throws:

NullPointerException - if moduleName or localName or any of parameters is null

IllegalArgumentException - if name has an invalid format or any parameter in parameters is invalid or there are duplicate parameters

withParameterNames

public RoleUnitName withParameterNames(Collection<String> paramNames)

Returns this role unit name rebased using the specified parameter names. If this role unit name contains a parameter which is not in the list, the parameter will be missing.

Parameters:

paramNames -

Returns:

this role unit name with the specified list of parameter names

Throws:

NullPointerException - if the paramNames is null or any of its elements is null

getName

public String getName()

Returns the simple name (i.e. RoleUnit name) of this role or organization unit.

Returns:

the simple name of this role or organization unit

getNameWithParameters

public String getNameWithParameters()

Returns the full name (i.e. RoleUnit name) of this role or organization unit together with all parameters bound to this role or organization unit.

Returns:

the full name of this role or organization unit together with all parameters bound to this role or organization unit

Since:

1.2

getModuleName

public String getModuleName()

Returns the module name of this role or organization unit.

Returns:

the module name of this role or organization unit

getLocalName

public String getLocalName()

Returns the local name of this role or organization unit, i.e. the name of this role or organization unit within its enclosing module.

Returns:

the local name of this role or organization unit

getParametersMap

public Map<String,String> getParametersMap()

Returns a map of parameter names and values of this RoleUnitName . This map preserves the order of parameters.

Returns:

a map of parameter names and values of this RoleUnitName

getParameters

public List<RoleUnitParameter> getParameters()

Returns a collection of parameters. This list preserves the order of parameters.

Returns:

a collection of parameters

getParameterNames

public Set<String> getParameterNames()

Returns a set of parameter names present in this RoleUnitName. This set preserves the order of parameter names.

Returns:

a collection of parameter names present in this RoleUnitName

getParameter

public String getParameter(String name)

Returns the value of a parameter identified by given name or null if the parameter with such name does not exist for this role or organization unit.

Parameters:

name - a name of a parameter

Returns:

the value of a parameter identified by given name or null if the parameter with such name does not exist for this role or organization unit

matches

public boolean matches(RoleUnitName other)

Returns true if this role matches the other role, i.e. the role names are the same and for each non-null parameter value of the other role, this role has the same parameter value or null. This relation is reflexive and symmetric.

Parameters:

other -

Returns:

true if this role matches the other role

Throws:

NullPointerException - if other is null

matches

public boolean matches(Collection<RoleUnitName> others)

Returns true if this role matches at least one of the other roles.

Parameters:

others -

Returns:

true if this role matches at least one of the other roles

Throws:

NullPointerException - if others or any role in others is null

isSubRole

public boolean isSubRole(RoleUnitName other)

Returns true if this role is a sub-role of the other role, i.e. the role names are the same and for each non-null parameter value of the other role, this role has the same parameter value. This relation is reflexive and transitive.

Parameters:

other -

Returns:

true if this role is a sub-role of the other role

Throws:

NullPointerException - if other is null

matches

public static boolean matches(Collection<RoleUnitName> roles1,
                              Collection<RoleUnitName> roles2)

Returns true if at least one role in roles1 matches at least one role in roles2.

Parameters:

roles1 -

roles2 -

Returns:

true if at least one role in roles1 matches at least one role in roles2

Throws:

NullPointerException - if roles1 or roles2 or any role in roles1 or in roles2 is null

removeSubRoles

public static Set<RoleUnitName> removeSubRoles(Collection<RoleUnitName> roles)

Returns a set of RoleUnitNames with all sub-roles removed.

Parameters:

roles -

Returns:

a set of RoleUnitNames with all sub-roles removed

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

beforeUnmarshal

public void beforeUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                            Object parent)

afterUnmarshal

public void afterUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                           Object parent)