Enum Index
- java.lang.Object
-
- java.lang.Enum<Index>
-
- org.infinispan.configuration.cache.Index
-
- All Implemented Interfaces:
Serializable
,Comparable<Index>
public enum Index extends Enum<Index>
Used to configure indexing of entries in the cache for index-assisted searching.- Author:
- Paul Ferraro
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ALL
All cluster nodes will add the entry to the index.LOCAL
Deprecated.since 9.1NONE
No indexing is performed.PRIMARY_OWNER
Only the primary owner of an entry will add it to the index.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
isEnabled()
Is indexing enabled?boolean
isLocalOnly()
Deprecated.boolean
isPrimaryOwner()
static Index
valueOf(String name)
Returns the enum constant of this type with the specified name.static Index[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NONE
public static final Index NONE
No indexing is performed.
-
LOCAL
@Deprecated public static final Index LOCAL
Deprecated.since 9.1The local (originator) node is responsible for adding the entry to the index. This indexing mode is deprecated; usePRIMARY_OWNER
instead.
-
ALL
public static final Index ALL
All cluster nodes will add the entry to the index.
-
PRIMARY_OWNER
public static final Index PRIMARY_OWNER
Only the primary owner of an entry will add it to the index.
-
-
Method Detail
-
values
public static Index[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Index c : Index.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Index valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
isEnabled
public boolean isEnabled()
Is indexing enabled?
-
isLocalOnly
@Deprecated public boolean isLocalOnly()
Deprecated.
-
isPrimaryOwner
public boolean isPrimaryOwner()
-
-