EhCacheService (Rythm Template Engine 1.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.rythmengine.cache
Enum EhCacheService

java.lang.Object
  java.lang.Enum<EhCacheService>
      org.rythmengine.cache.EhCacheService

All Implemented Interfaces:: Serializable, Comparable<EhCacheService>, ICacheService

public enum EhCacheService
extends Enum<EhCacheService>
implements ICacheService
extends Enum<EhCacheService>
implements ICacheService

implement cache service based on EHCACHE

Enum Constant Summary
`INSTANCE`

Method Summary
`void`	`clear()` Remove all cached items
`boolean`	`contains(String key)` Check if the cache contains key
`void`	`evict(String key)` Remove an item from the cache service by key
`Serializable`	`get(String key)` Return an item from the cache service by key
`void`	`put(String key, Serializable value)` Store an item into the cache by key and use default ttl
`void`	`put(String key, Serializable value, int ttl)` Store an item into the cache service by key and set ttl value
`Serializable`	`remove(String key)` Remove an item from cache service by key
`void`	`setDefaultTTL(int ttl)` Set default ttl value which will be used if user pass 0 as ttl or not specified ttl
`void`	`shutdown()` Shutdown the cache service
`void`	`startup()` Restart the cache service after shutdown
`static EhCacheService`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static EhCacheService[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

INSTANCE

public static final EhCacheService INSTANCE

Method Detail

values

public static EhCacheService[] 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 (EhCacheService c : EhCacheService.values())
    System.out.println(c);

Returns:: an array containing the constants of this enum type, in the order they are declared

valueOf

public static EhCacheService 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 name; NullPointerException - if the argument is null