org.jboss.shrinkwrap.descriptor.api.jboss51
Interface CacheConfigType<T>

All Superinterfaces:
org.jboss.shrinkwrap.descriptor.api.Child<T>
All Known Implementing Classes:
CacheConfigTypeImpl

public interface CacheConfigType<T>
extends org.jboss.shrinkwrap.descriptor.api.Child<T>

This interface defines the contract for the cache-configType xsd type

Original Documentation:

Element for specifying the class used to provide the caching mechanism for a bean,
and the cache parameters

Since:
Generation date :2011-07-19T22:54:35.59+02:00
Author:
Ralf Battenfeld

Method Summary
 java.lang.Integer getCacheMaxSize()
          Returns the cache-max-size element
 java.lang.String getCacheName()
          Returns the cache-name element
 java.lang.String getCacheValue()
          Returns the cache-value element
 java.lang.Integer getIdleTimeoutSeconds()
          Returns the idle-timeout-seconds element
 java.lang.String getPersistenceManager()
          Returns the persistence-manager element
 java.lang.Integer getRemoveTimeoutSeconds()
          Returns the remove-timeout-seconds element
 java.lang.String getReplicationIsPassivation()
          Returns the replication-is-passivation element
 CacheConfigType<T> removeCacheMaxSize()
          Removes the cache-max-size element
 CacheConfigType<T> removeCacheName()
          Removes the cache-name element
 CacheConfigType<T> removeCacheValue()
          Removes the cache-value element
 CacheConfigType<T> removeIdleTimeoutSeconds()
          Removes the idle-timeout-seconds element
 CacheConfigType<T> removePersistenceManager()
          Removes the persistence-manager element
 CacheConfigType<T> removeRemoveTimeoutSeconds()
          Removes the remove-timeout-seconds element
 CacheConfigType<T> removeReplicationIsPassivation()
          Removes the replication-is-passivation element
 CacheConfigType<T> setCacheMaxSize(java.lang.Integer cacheMaxSize)
          If not already created, a new cache-max-size element with the given value will be created.
 CacheConfigType<T> setCacheName(java.lang.String cacheName)
          If not already created, a new cache-name element with the given value will be created.
 CacheConfigType<T> setCacheValue(java.lang.String cacheValue)
          If not already created, a new cache-value element with the given value will be created.
 CacheConfigType<T> setIdleTimeoutSeconds(java.lang.Integer idleTimeoutSeconds)
          If not already created, a new idle-timeout-seconds element with the given value will be created.
 CacheConfigType<T> setPersistenceManager(java.lang.String persistenceManager)
          If not already created, a new persistence-manager element with the given value will be created.
 CacheConfigType<T> setRemoveTimeoutSeconds(java.lang.Integer removeTimeoutSeconds)
          If not already created, a new remove-timeout-seconds element with the given value will be created.
 CacheConfigType<T> setReplicationIsPassivation(java.lang.String replicationIsPassivation)
          If not already created, a new replication-is-passivation element with the given value will be created.
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up
 

Method Detail

setCacheValue

CacheConfigType<T> setCacheValue(java.lang.String cacheValue)
If not already created, a new cache-value element with the given value will be created. Otherwise, the existing cache-value element will be updated with the given value.

Returns:
the current instance of CacheConfigType

removeCacheValue

CacheConfigType<T> removeCacheValue()
Removes the cache-value element

Returns:
the current instance of CacheConfigType

getCacheValue

java.lang.String getCacheValue()
Returns the cache-value element

Returns:
the node defined for the element cache-value

setCacheMaxSize

CacheConfigType<T> setCacheMaxSize(java.lang.Integer cacheMaxSize)
If not already created, a new cache-max-size element with the given value will be created. Otherwise, the existing cache-max-size element will be updated with the given value.

Returns:
the current instance of CacheConfigType

removeCacheMaxSize

CacheConfigType<T> removeCacheMaxSize()
Removes the cache-max-size element

Returns:
the current instance of CacheConfigType

getCacheMaxSize

java.lang.Integer getCacheMaxSize()
Returns the cache-max-size element

Returns:
the node defined for the element cache-max-size

setIdleTimeoutSeconds

CacheConfigType<T> setIdleTimeoutSeconds(java.lang.Integer idleTimeoutSeconds)
If not already created, a new idle-timeout-seconds element with the given value will be created. Otherwise, the existing idle-timeout-seconds element will be updated with the given value.

Returns:
the current instance of CacheConfigType

removeIdleTimeoutSeconds

CacheConfigType<T> removeIdleTimeoutSeconds()
Removes the idle-timeout-seconds element

Returns:
the current instance of CacheConfigType

getIdleTimeoutSeconds

java.lang.Integer getIdleTimeoutSeconds()
Returns the idle-timeout-seconds element

Returns:
the node defined for the element idle-timeout-seconds

setRemoveTimeoutSeconds

CacheConfigType<T> setRemoveTimeoutSeconds(java.lang.Integer removeTimeoutSeconds)
If not already created, a new remove-timeout-seconds element with the given value will be created. Otherwise, the existing remove-timeout-seconds element will be updated with the given value.

Returns:
the current instance of CacheConfigType

removeRemoveTimeoutSeconds

CacheConfigType<T> removeRemoveTimeoutSeconds()
Removes the remove-timeout-seconds element

Returns:
the current instance of CacheConfigType

getRemoveTimeoutSeconds

java.lang.Integer getRemoveTimeoutSeconds()
Returns the remove-timeout-seconds element

Returns:
the node defined for the element remove-timeout-seconds

setCacheName

CacheConfigType<T> setCacheName(java.lang.String cacheName)
If not already created, a new cache-name element with the given value will be created. Otherwise, the existing cache-name element will be updated with the given value.

Returns:
the current instance of CacheConfigType

removeCacheName

CacheConfigType<T> removeCacheName()
Removes the cache-name element

Returns:
the current instance of CacheConfigType

getCacheName

java.lang.String getCacheName()
Returns the cache-name element

Returns:
the node defined for the element cache-name

setPersistenceManager

CacheConfigType<T> setPersistenceManager(java.lang.String persistenceManager)
If not already created, a new persistence-manager element with the given value will be created. Otherwise, the existing persistence-manager element will be updated with the given value.

Returns:
the current instance of CacheConfigType

removePersistenceManager

CacheConfigType<T> removePersistenceManager()
Removes the persistence-manager element

Returns:
the current instance of CacheConfigType

getPersistenceManager

java.lang.String getPersistenceManager()
Returns the persistence-manager element

Returns:
the node defined for the element persistence-manager

setReplicationIsPassivation

CacheConfigType<T> setReplicationIsPassivation(java.lang.String replicationIsPassivation)
If not already created, a new replication-is-passivation element with the given value will be created. Otherwise, the existing replication-is-passivation element will be updated with the given value.

Returns:
the current instance of CacheConfigType

removeReplicationIsPassivation

CacheConfigType<T> removeReplicationIsPassivation()
Removes the replication-is-passivation element

Returns:
the current instance of CacheConfigType

getReplicationIsPassivation

java.lang.String getReplicationIsPassivation()
Returns the replication-is-passivation element

Returns:
the node defined for the element replication-is-passivation