com.phloc.commons.collections.flags

Class ReadonlyFlagContainer

java.lang.Object

com.phloc.commons.collections.flags.ReadonlyFlagContainer

All Implemented Interfaces:

IReadonlyFlagContainer, Serializable

@NotThreadSafe
public final class ReadonlyFlagContainer
extends Object
implements IReadonlyFlagContainer

Default implementation of the IReadonlyFlagContainer based on a hash set.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReadonlyFlagContainer(Collection<String> aValues)
ReadonlyFlagContainer(IReadonlyFlagContainer aCont)
ReadonlyFlagContainer(String... aValues)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsFlag(String sName) Check if an flag of the given name is contained.
boolean	containsNoFlag()
boolean	equals(Object o)
Set<String>	getAllFlags()
int	getFlagCount()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadonlyFlagContainer

public ReadonlyFlagContainer(@Nonnull
                     Collection<String> aValues)

ReadonlyFlagContainer

public ReadonlyFlagContainer(@Nonnull
                     String... aValues)

ReadonlyFlagContainer

public ReadonlyFlagContainer(@Nonnull
                     IReadonlyFlagContainer aCont)

Method Detail

containsFlag

public boolean containsFlag(@Nullable
                   String sName)

Description copied from interface: IReadonlyFlagContainer

Check if an flag of the given name is contained.

Specified by:

containsFlag in interface IReadonlyFlagContainer

Parameters:

sName - name of the flag to check

Returns:

true if the flag is contained, false otherwise

getAllFlags

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

Specified by:

getAllFlags in interface IReadonlyFlagContainer

Returns:

The non-null set with all contained flags.

getFlagCount

@Nonnegative
public int getFlagCount()

Specified by:

getFlagCount in interface IReadonlyFlagContainer

Returns:

The number of contained flags. Always ≥ 0.

containsNoFlag

public boolean containsNoFlag()

Specified by:

containsNoFlag in interface IReadonlyFlagContainer

Returns:

true if this flag container does not contain any flag at all, false if at least one flag is contained.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object