com.phloc.commons.collections.flags

Class FlagContainer

java.lang.Object

com.phloc.commons.collections.flags.FlagContainer

All Implemented Interfaces:

IFlagContainer, IReadonlyFlagContainer, IClearable, Serializable

Direct Known Subclasses:

FlagContainerThreadSafe

@NotThreadSafe
public class FlagContainer
extends Object
implements IFlagContainer

The not-thread safe implementation of IFlagContainer.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
EChange	addFlag(String sName) Add a flag if it is not yet present.
EChange	addFlags(Collection<String> aValues) Add an arbitrary number of flags if they are not yet present.
EChange	addFlags(String... aValues) Add an arbitrary number of flags if they are 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 java.lang.Object

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

Constructor Detail

FlagContainer

public FlagContainer()

FlagContainer

public FlagContainer(@Nonnull
             Collection<String> aValues)

FlagContainer

public FlagContainer(@Nonnull
             String... aValues)

FlagContainer

public FlagContainer(@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.

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

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)

addFlags

@Nonnull
public final EChange addFlags(@Nullable
                       Collection<String> aValues)

Description copied from interface: IFlagContainer

Add an arbitrary number of flags if they are not yet present.

Specified by:

addFlags in interface IFlagContainer

Parameters:

aValues - The collections of flags to be set. May be null.

Returns:

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

See Also:

IFlagContainer.addFlag(String)

addFlags

@Nonnull
public final EChange addFlags(@Nullable
                       String... aValues)

Description copied from interface: IFlagContainer

Add an arbitrary number of flags if they are not yet present.

Specified by:

addFlags in interface IFlagContainer

Parameters:

aValues - The collections of flags to be set. May be null.

Returns:

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

See Also:

IFlagContainer.addFlag(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

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

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.

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

Returns:

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

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