com.helger.photon.basic.security.usergroup

Class UserGroup

java.lang.Object

com.helger.commons.collections.attrs.AbstractGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>

com.helger.commons.collections.attrs.MapBasedAttributeContainer

com.helger.photon.basic.security.usergroup.UserGroup

All Implemented Interfaces:

com.helger.commons.collections.attrs.IAttributeContainer, com.helger.commons.collections.attrs.IGenericAttributeContainer<String,Object>, com.helger.commons.collections.attrs.IGenericReadonlyAttributeContainer<String,Object>, com.helger.commons.collections.attrs.IReadonlyAttributeContainer, com.helger.commons.ICloneable<com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>>, com.helger.commons.id.IHasID<String>, com.helger.commons.name.IHasDescription, com.helger.commons.name.IHasName, com.helger.commons.state.IClearable, com.helger.commons.type.IHasType, com.helger.commons.type.ITypedObject<String>, IRoleContainer, IUserContainer, IUserGroup, Serializable

@NotThreadSafe
public final class UserGroup
extends com.helger.commons.collections.attrs.MapBasedAttributeContainer
implements IUserGroup

Default implementation of the IUserGroup interface.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserGroup(String sName, String sDescription, Map<String,?> aCustomAttrs)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsRoleID(String sRoleID) Check if the passed role is contained in this container.
boolean	containsUserID(String sUserID) Check if the passed user is contained in this container.
boolean	equals(Object o)
Set<String>	getAllContainedRoleIDs()
Set<String>	getAllContainedUserIDs()
int	getContainedRoleCount()
int	getContainedUserCount()
String	getDescription()
String	getID()
String	getName()
com.helger.commons.type.ObjectType	getTypeID()
boolean	hasContainedRoles()
boolean	hasContainedUsers()
int	hashCode()
String	toString()

Methods inherited from class com.helger.commons.collections.attrs.MapBasedAttributeContainer

getAndSetAttributeFlag, getClone, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from class com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer

clear, containsAttribute, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeCount, getAttributeNames, getAttributeObject, onBeforeRemoveAttribute, onBeforeSetAttributeValue, removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from class com.helger.commons.collections.attrs.AbstractGenericReadonlyAttributeContainer

getAsBigDecimal, getAsBigInteger, getAsBoolean, getAsDouble, getAsInt, getAsLong, getAsString, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.collections.attrs.IGenericReadonlyAttributeContainer

containsAttribute, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getAttributeCount, getAttributeNames, getAttributeObject, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute

Methods inherited from interface com.helger.commons.collections.attrs.IGenericAttributeContainer

removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from interface com.helger.commons.state.IClearable

clear

Constructor Detail

UserGroup

public UserGroup(@Nonnull@Nonempty
         String sName,
         @Nullable
         String sDescription,
         @Nullable
         Map<String,?> aCustomAttrs)

Method Detail

getTypeID

@Nonnull
public com.helger.commons.type.ObjectType getTypeID()

Specified by:

getTypeID in interface com.helger.commons.type.IHasType

getID

@Nonnull
@Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

getName

@Nonnull
@Nonempty
public String getName()

Specified by:

getName in interface com.helger.commons.name.IHasName

getDescription

@Nullable
public String getDescription()

Specified by:

getDescription in interface com.helger.commons.name.IHasDescription

hasContainedUsers

public boolean hasContainedUsers()

Specified by:

hasContainedUsers in interface IUserContainer

Returns:

true if at least one user is contained, false otherwise.

getContainedUserCount

@Nonnegative
public int getContainedUserCount()

Specified by:

getContainedUserCount in interface IUserContainer

Returns:

The number of contained users. Always ≥ 0.

getAllContainedUserIDs

@Nonnull
@ReturnsMutableCopy
public Set<String> getAllContainedUserIDs()

Specified by:

getAllContainedUserIDs in interface IUserContainer

Returns:

A non-nullbut maybe empty set of all assigned user IDs.

containsUserID

public boolean containsUserID(String sUserID)

Description copied from interface: IUserContainer

Check if the passed user is contained in this container.

Specified by:

containsUserID in interface IUserContainer

Parameters:

sUserID - The user ID to check. May be null.

Returns:

true if the user is contained in this container, false otherwise.

hasContainedRoles

public boolean hasContainedRoles()

Specified by:

hasContainedRoles in interface IRoleContainer

Returns:

true if at least one role is contained, false otherwise.

getContainedRoleCount

@Nonnegative
public int getContainedRoleCount()

Specified by:

getContainedRoleCount in interface IRoleContainer

Returns:

The number of contained roles. Always ≥ 0.

getAllContainedRoleIDs

@Nonnull
@ReturnsMutableCopy
public Set<String> getAllContainedRoleIDs()

Specified by:

getAllContainedRoleIDs in interface IRoleContainer

Returns:

A non-nullbut maybe empty set of all assigned role IDs.

containsRoleID

public boolean containsRoleID(String sRoleID)

Description copied from interface: IRoleContainer

Check if the passed role is contained in this container.

Specified by:

containsRoleID in interface IRoleContainer

Parameters:

sRoleID - The role ID to check. May be null.

Returns:

true if the role is contained in this container, false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>

hashCode

public int hashCode()

Overrides:

hashCode in class com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>

toString

public String toString()

Overrides:

toString in class com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>