Package com.googlecode.cqengine.query.option

Class FlagsEnabled

java.lang.Object

com.googlecode.cqengine.query.option.FlagsEnabled

public class FlagsEnabled
extends Object

A wrapper around object keys ("flags") which are said to be enabled.

Example usage using QueryFactory:
QueryOptions queryOptions = queryOptions(enableFlags("flag1", "flag2"))

Author:

niall.gallagher

Constructor Summary

Constructors

Constructor	Description
FlagsEnabled()

Method Summary

Modifier and Type	Method	Description
void	add(Object flag)
static FlagsEnabled	forQueryOptions(QueryOptions queryOptions)	Returns an existing FlagsEnabled from the QueryOptions, or adds a new instance to the query options and returns that.
static boolean	isFlagEnabled(QueryOptions queryOptions, Object flag)
boolean	isFlagEnabled(Object flag)
void	remove(Object flag)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FlagsEnabled

public FlagsEnabled()

Method Detail

add

public void add(Object flag)

remove

public void remove(Object flag)

isFlagEnabled

public boolean isFlagEnabled(Object flag)

toString

public String toString()

Overrides:

toString in class Object

forQueryOptions

public static FlagsEnabled forQueryOptions(QueryOptions queryOptions)

Returns an existing FlagsEnabled from the QueryOptions, or adds a new instance to the query options and returns that.

Parameters:

queryOptions - The QueryOptions

Returns:

The existing QueryOptions's FlagsEnabled or a new instance.

isFlagEnabled

public static boolean isFlagEnabled(QueryOptions queryOptions,
                                    Object flag)