com.phloc.commons.collections.flags

Interface IReadonlyFlagContainer

All Superinterfaces:

Serializable

All Known Subinterfaces:

IFlagContainer

All Known Implementing Classes:

FlagContainer, FlagContainerThreadSafe, ReadonlyFlagContainer

public interface IReadonlyFlagContainer
extends Serializable

Base interface for a generic read-only flag container. It maps strings to any Java object.

Author:

Philip Helger

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()
Set<String>	getAllFlags()
int	getFlagCount()

Method Detail

getFlagCount

@Nonnegative
int getFlagCount()

Returns:

The number of contained flags. Always ≥ 0.

containsNoFlag

boolean containsNoFlag()

Returns:

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

containsFlag

boolean containsFlag(@Nullable
                   String sName)

Check if an flag of the given name is contained.

Parameters:

sName - name of the flag to check

Returns:

true if the flag is contained, false otherwise

getAllFlags

@Nonnull
@ReturnsMutableCopy
Set<String> getAllFlags()

Returns:

The non-null set with all contained flags.