Package de.hybris.platform.regioncache.region

Enum Class RegionType

java.lang.Object

java.lang.Enum<RegionType>

de.hybris.platform.regioncache.region.RegionType

All Implemented Interfaces:

Serializable, Comparable<RegionType>, Constable

public enum RegionType
extends Enum<RegionType>

Defines 'special' type codes for defining cache region.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL_TYPES	_ALL_TYPES: region is handling all possible types available in the platform.
NON_REGISTRABLE	Flag marks registry as no handling queries
QUERY_CACHE_TYPE	All types which uses cache registry.

Method Summary

Modifier and Type	Method	Description
boolean	requiresRegistry()	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0
String	value()
static RegionType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RegionType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL_TYPES

public static final RegionType ALL_TYPES

_ALL_TYPES: region is handling all possible types available in the platform. One of defined regions MUST be configured to handle all types. If region R1 handles type T and the region R2 handles __ALL_TYPES_ only it is assumed that R2 does not handle T. To make R2 handling type T it should be configured for handling T and _ALL_TYPES_,

NON_REGISTRABLE

public static final RegionType NON_REGISTRABLE

Flag marks registry as no handling queries

QUERY_CACHE_TYPE

public static final RegionType QUERY_CACHE_TYPE

All types which uses cache registry.

Method Details

values

public static RegionType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RegionType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

requiresRegistry

@Deprecated(since="5.0",
            forRemoval=true)
public boolean requiresRegistry()

Deprecated, for removal: This API element is subject to removal in a future version.

since 5.0