com.helger.commons.collections.flags

Class FlagContainerThreadSafe

java.lang.Object

com.helger.commons.collections.flags.FlagContainer

com.helger.commons.collections.flags.FlagContainerThreadSafe

All Implemented Interfaces:

IFlagContainer, IReadonlyFlagContainer, IClearable, Serializable

@ThreadSafe
public class FlagContainerThreadSafe
extends FlagContainer

Base class for all kind of string-object mapping container. This implementation is a thread-safe wrapper around FlagContainer!

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadWriteLock	m_aRWLock

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EChange	addFlag(String sName) Add a flag if it is not yet present.
EChange	clear() Reset the contents of the element to the after-construction state.
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()
EChange	removeFlag(String sName) Remove the specified flag from the container.
String	toString()

Methods inherited from class com.helger.commons.collections.flags.FlagContainer

addFlags, addFlags

Methods inherited from class java.lang.Object

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

Field Detail

m_aRWLock

protected final ReadWriteLock m_aRWLock

Constructor Detail

FlagContainerThreadSafe

public FlagContainerThreadSafe()

FlagContainerThreadSafe

public FlagContainerThreadSafe(@Nonnull
                               Collection<String> aValues)

FlagContainerThreadSafe

public FlagContainerThreadSafe(@Nonnull
                               String... aValues)

FlagContainerThreadSafe

public FlagContainerThreadSafe(@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

Overrides:

containsFlag in class FlagContainer

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

Overrides:

getAllFlags in class FlagContainer

Returns:

The non-null set with all contained flags.

addFlag

@Nonnull
public EChange addFlag(@Nonnull
                                 String sName)

Description copied from interface: IFlagContainer

Add a flag if it is not yet present.

Specified by:

addFlag in interface IFlagContainer

Overrides:

addFlag in class FlagContainer

Parameters:

sName - The name of the flag. May not be null.

Returns:

EChange.CHANGED if something changed, EChange.UNCHANGED otherwise.

See Also:

IFlagContainer.removeFlag(String)

removeFlag

@Nonnull
public EChange removeFlag(@Nullable
                                    String sName)

Description copied from interface: IFlagContainer

Remove the specified flag from the container.

Specified by:

removeFlag in interface IFlagContainer

Overrides:

removeFlag in class FlagContainer

Parameters:

sName - The flag name to be removed. If it is null nothing happens.

Returns:

EChange.CHANGED if something changed, EChange.UNCHANGED otherwise.

getFlagCount

@Nonnegative
public int getFlagCount()

Specified by:

getFlagCount in interface IReadonlyFlagContainer

Overrides:

getFlagCount in class FlagContainer

Returns:

The number of contained flags. Always ≥ 0.

containsNoFlag

public boolean containsNoFlag()

Specified by:

containsNoFlag in interface IReadonlyFlagContainer

Overrides:

containsNoFlag in class FlagContainer

Returns:

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

clear

@Nonnull
public EChange clear()

Description copied from interface: IClearable

Reset the contents of the element to the after-construction state.

Specified by:

clear in interface IClearable

Overrides:

clear in class FlagContainer

Returns:

EChange.CHANGED if at least one element was cleared, EChange.UNCHANGED otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class FlagContainer

hashCode

public int hashCode()

Overrides:

hashCode in class FlagContainer

toString

public String toString()

Overrides:

toString in class FlagContainer