com.helger.commons.collections.flags

Interface IFlagContainer

All Superinterfaces:

IClearable, IReadonlyFlagContainer, Serializable

All Known Implementing Classes:

FlagContainer, FlagContainerThreadSafe

public interface IFlagContainer
extends IReadonlyFlagContainer, IClearable

This is the writable extension of the IReadonlyFlagContainer.

Author:

Philip Helger

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	removeFlag(String sName) Remove the specified flag from the container.

Methods inherited from interface com.helger.commons.collections.flags.IReadonlyFlagContainer

containsFlag, containsNoFlag, getAllFlags, getFlagCount

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

clear

Method Detail

addFlag

@Nonnull
EChange addFlag(@Nonnull
                      String sName)

Add a flag if it is not yet present.

Parameters:

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

Returns:

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

See Also:

removeFlag(String)

addFlags

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

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

Parameters:

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

Returns:

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

See Also:

addFlag(String)

addFlags

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

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

Parameters:

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

Returns:

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

See Also:

addFlag(String)

removeFlag

@Nonnull
EChange removeFlag(@Nullable
                         String sName)

Remove the specified flag from the container.

Parameters:

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

Returns:

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