org.eclipse.jpt.eclipselink.core.context
Interface Caching

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model

All Known Subinterfaces:

JavaCaching, OrmCaching

public interface Caching
extends JpaContextNode

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

2.1

Version:

2.1

Field Summary

static boolean	DEFAULT_ALWAYS_REFRESH
static java.lang.String	DEFAULT_ALWAYS_REFRESH_PROPERTY
static CacheCoordinationType	DEFAULT_COORDINATION_TYPE
static java.lang.String	DEFAULT_COORDINATION_TYPE_PROPERTY
static boolean	DEFAULT_DISABLE_HITS
static java.lang.String	DEFAULT_DISABLE_HITS_PROPERTY
static ExistenceType	DEFAULT_EXISTENCE_TYPE
static java.lang.String	DEFAULT_EXISTENCE_TYPE_PROPERTY
static boolean	DEFAULT_REFRESH_ONLY_IF_NEWER
static java.lang.String	DEFAULT_REFRESH_ONLY_IF_NEWER_PROPERTY
static boolean	DEFAULT_SHARED
static java.lang.String	DEFAULT_SHARED_PROPERTY
static int	DEFAULT_SIZE
static java.lang.String	DEFAULT_SIZE_PROPERTY
static CacheType	DEFAULT_TYPE
static java.lang.String	DEFAULT_TYPE_PROPERTY
static java.lang.String	EXPIRY_PROPERTY
static java.lang.String	EXPIRY_TIME_OF_DAY_PROPERTY
static java.lang.String	SPECIFIED_ALWAYS_REFRESH_PROPERTY
static java.lang.String	SPECIFIED_COORDINATION_TYPE_PROPERTY
static java.lang.String	SPECIFIED_DISABLE_HITS_PROPERTY
static java.lang.String	SPECIFIED_EXISTENCE_TYPE_PROPERTY
static java.lang.String	SPECIFIED_REFRESH_ONLY_IF_NEWER_PROPERTY
static java.lang.String	SPECIFIED_SHARED_PROPERTY
static java.lang.String	SPECIFIED_SIZE_PROPERTY
static java.lang.String	SPECIFIED_TYPE_PROPERTY

Method Summary

ExpiryTimeOfDay	addExpiryTimeOfDay() Add Cache expiryTimeOfDay annotation or xml element, this will set Expiry to null as it is not valid to set both expiry and timeOfDayExpiry
CacheCoordinationType	getCoordinationType() This is the combination of defaultCoordinationType and specifiedCoordinationType.
CacheCoordinationType	getDefaultCoordinationType()
ExistenceType	getDefaultExistenceType()
int	getDefaultSize()
CacheType	getDefaultType()
ExistenceType	getExistenceType() This is the combination of defaultExistenceType and specifiedExistenceType.
java.lang.Integer	getExpiry() corresponds to the Cache expiry element.
ExpiryTimeOfDay	getExpiryTimeOfDay() corresponds to the Cache expiryTimeOfDay annotation or xml element.
int	getSize() This is the combination of defaultSize and specifiedSize.
java.lang.Boolean	getSpecifiedAlwaysRefresh()
CacheCoordinationType	getSpecifiedCoordinationType()
java.lang.Boolean	getSpecifiedDisableHits()
ExistenceType	getSpecifiedExistenceType()
java.lang.Boolean	getSpecifiedRefreshOnlyIfNewer()
java.lang.Boolean	getSpecifiedShared()
java.lang.Integer	getSpecifiedSize()
CacheType	getSpecifiedType()
CacheType	getType() This is the combination of defaultType and specifiedType.
boolean	isAlwaysRefresh() This is the combination of defaultAlwaysRefresh and specifiedAlwaysRefresh.
boolean	isDefaultAlwaysRefresh()
boolean	isDefaultDisableHits()
boolean	isDefaultRefreshOnlyIfNewer()
boolean	isDefaultShared()
boolean	isDisableHits() This is the combination of defaultDisableHits and specifiedDisableHits.
boolean	isRefreshOnlyIfNewer() This is the combination of defaultRefreshOnlyIfNewer and specifiedRefreshOnlyIfNewer.
boolean	isShared() This is the combination of defaultShared and specifiedShared.
void	removeExpiryTimeOfDay() Removes the Cache expiryTimeOfDay annotation/xml element
void	setExpiry(java.lang.Integer expiry) Setting this to a non-null value will set timeOfDayExpiry to null
void	setSpecifiedAlwaysRefresh(java.lang.Boolean newSpecifiedAlwaysRefresh)
void	setSpecifiedCoordinationType(CacheCoordinationType newSpecifiedCoordinationType)
void	setSpecifiedDisableHits(java.lang.Boolean newSpecifiedDisableHits)
void	setSpecifiedExistenceType(ExistenceType newSpecifiedExistenceType)
void	setSpecifiedRefreshOnlyIfNewer(java.lang.Boolean newSpecifiedRefreshOnlyIfNewer)
void	setSpecifiedShared(java.lang.Boolean newSpecifiedShared) Setting this to false means that cacheType, cacheSize, alwaysRefresh, refreshOnlyIfNewer, disableHits, cacheCoordinationType will all be set to their default states.
void	setSpecifiedSize(java.lang.Integer newSpecifiedSize)
void	setSpecifiedType(CacheType newSpecifiedType)

Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, postUpdate

Methods inherited from interface org.eclipse.jpt.core.JpaNode

getJpaProject, getParent

Methods inherited from interface org.eclipse.jpt.utility.model.Model

addCollectionChangeListener, addCollectionChangeListener, addListChangeListener, addListChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, addTreeChangeListener, removeCollectionChangeListener, removeCollectionChangeListener, removeListChangeListener, removeListChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener, removeTreeChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.core.IResourcePart

getResource

Field Detail

DEFAULT_SHARED_PROPERTY

static final java.lang.String DEFAULT_SHARED_PROPERTY

See Also:

Constant Field Values

DEFAULT_SHARED

static final boolean DEFAULT_SHARED

See Also:

Constant Field Values

SPECIFIED_SHARED_PROPERTY

static final java.lang.String SPECIFIED_SHARED_PROPERTY

See Also:

Constant Field Values

DEFAULT_TYPE_PROPERTY

static final java.lang.String DEFAULT_TYPE_PROPERTY

See Also:

Constant Field Values

DEFAULT_TYPE

static final CacheType DEFAULT_TYPE

SPECIFIED_TYPE_PROPERTY

static final java.lang.String SPECIFIED_TYPE_PROPERTY

See Also:

Constant Field Values

DEFAULT_SIZE

static final int DEFAULT_SIZE

See Also:

Constant Field Values

DEFAULT_SIZE_PROPERTY

static final java.lang.String DEFAULT_SIZE_PROPERTY

See Also:

Constant Field Values

SPECIFIED_SIZE_PROPERTY

static final java.lang.String SPECIFIED_SIZE_PROPERTY

See Also:

Constant Field Values

DEFAULT_ALWAYS_REFRESH_PROPERTY

static final java.lang.String DEFAULT_ALWAYS_REFRESH_PROPERTY

See Also:

Constant Field Values

DEFAULT_ALWAYS_REFRESH

static final boolean DEFAULT_ALWAYS_REFRESH

See Also:

Constant Field Values

SPECIFIED_ALWAYS_REFRESH_PROPERTY

static final java.lang.String SPECIFIED_ALWAYS_REFRESH_PROPERTY

See Also:

Constant Field Values

DEFAULT_REFRESH_ONLY_IF_NEWER_PROPERTY

static final java.lang.String DEFAULT_REFRESH_ONLY_IF_NEWER_PROPERTY

See Also:

Constant Field Values

DEFAULT_REFRESH_ONLY_IF_NEWER

static final boolean DEFAULT_REFRESH_ONLY_IF_NEWER

See Also:

Constant Field Values

SPECIFIED_REFRESH_ONLY_IF_NEWER_PROPERTY

static final java.lang.String SPECIFIED_REFRESH_ONLY_IF_NEWER_PROPERTY

See Also:

Constant Field Values

DEFAULT_DISABLE_HITS_PROPERTY

static final java.lang.String DEFAULT_DISABLE_HITS_PROPERTY

See Also:

Constant Field Values

DEFAULT_DISABLE_HITS

static final boolean DEFAULT_DISABLE_HITS

See Also:

Constant Field Values

SPECIFIED_DISABLE_HITS_PROPERTY

static final java.lang.String SPECIFIED_DISABLE_HITS_PROPERTY

See Also:

Constant Field Values

DEFAULT_COORDINATION_TYPE_PROPERTY

static final java.lang.String DEFAULT_COORDINATION_TYPE_PROPERTY

See Also:

Constant Field Values

DEFAULT_COORDINATION_TYPE

static final CacheCoordinationType DEFAULT_COORDINATION_TYPE

SPECIFIED_COORDINATION_TYPE_PROPERTY

static final java.lang.String SPECIFIED_COORDINATION_TYPE_PROPERTY

See Also:

Constant Field Values

DEFAULT_EXISTENCE_TYPE_PROPERTY

static final java.lang.String DEFAULT_EXISTENCE_TYPE_PROPERTY

See Also:

Constant Field Values

DEFAULT_EXISTENCE_TYPE

static final ExistenceType DEFAULT_EXISTENCE_TYPE

SPECIFIED_EXISTENCE_TYPE_PROPERTY

static final java.lang.String SPECIFIED_EXISTENCE_TYPE_PROPERTY

See Also:

Constant Field Values

EXPIRY_PROPERTY

static final java.lang.String EXPIRY_PROPERTY

See Also:

Constant Field Values

EXPIRY_TIME_OF_DAY_PROPERTY

static final java.lang.String EXPIRY_TIME_OF_DAY_PROPERTY

See Also:

Constant Field Values

Method Detail

isShared

boolean isShared()

This is the combination of defaultShared and specifiedShared. If getSpecifiedShared() returns null, then return isDefaultShared()

isDefaultShared

boolean isDefaultShared()

getSpecifiedShared

java.lang.Boolean getSpecifiedShared()

setSpecifiedShared

void setSpecifiedShared(java.lang.Boolean newSpecifiedShared)

Setting this to false means that cacheType, cacheSize, alwaysRefresh, refreshOnlyIfNewer, disableHits, cacheCoordinationType will all be set to their default states. These settings do not apply to a cache that is not shared

Parameters:

newSpecifiedShared -

getType

CacheType getType()

This is the combination of defaultType and specifiedType. If getSpecifiedType() returns null, then return getDefaultType()

getDefaultType

CacheType getDefaultType()

getSpecifiedType

CacheType getSpecifiedType()

setSpecifiedType

void setSpecifiedType(CacheType newSpecifiedType)

getSize

int getSize()

This is the combination of defaultSize and specifiedSize. If getSpecifiedSize() returns null, then return getDefaultSize()

getDefaultSize

int getDefaultSize()

getSpecifiedSize

java.lang.Integer getSpecifiedSize()

setSpecifiedSize

void setSpecifiedSize(java.lang.Integer newSpecifiedSize)

isAlwaysRefresh

boolean isAlwaysRefresh()

This is the combination of defaultAlwaysRefresh and specifiedAlwaysRefresh. If getSpecifiedAlwaysRefresh() returns null, then return isDefaultAlwaysRefresh()

isDefaultAlwaysRefresh

boolean isDefaultAlwaysRefresh()

getSpecifiedAlwaysRefresh

java.lang.Boolean getSpecifiedAlwaysRefresh()

setSpecifiedAlwaysRefresh

void setSpecifiedAlwaysRefresh(java.lang.Boolean newSpecifiedAlwaysRefresh)

isRefreshOnlyIfNewer

boolean isRefreshOnlyIfNewer()

This is the combination of defaultRefreshOnlyIfNewer and specifiedRefreshOnlyIfNewer. If getSpecifiedRefreshOnlyIfNewer() returns null, then return isDefaultRefreshOnlyIfNewer()

isDefaultRefreshOnlyIfNewer

boolean isDefaultRefreshOnlyIfNewer()

getSpecifiedRefreshOnlyIfNewer

java.lang.Boolean getSpecifiedRefreshOnlyIfNewer()

setSpecifiedRefreshOnlyIfNewer

void setSpecifiedRefreshOnlyIfNewer(java.lang.Boolean newSpecifiedRefreshOnlyIfNewer)

isDisableHits

boolean isDisableHits()

This is the combination of defaultDisableHits and specifiedDisableHits. If getSpecifiedDisableHits() returns null, then return getDefaultDisableHits()

isDefaultDisableHits

boolean isDefaultDisableHits()

getSpecifiedDisableHits

java.lang.Boolean getSpecifiedDisableHits()

setSpecifiedDisableHits

void setSpecifiedDisableHits(java.lang.Boolean newSpecifiedDisableHits)

getCoordinationType

CacheCoordinationType getCoordinationType()

This is the combination of defaultCoordinationType and specifiedCoordinationType. If getSpecifiedCoordinationType() returns null, then return getDefaultCoordinationType()

getDefaultCoordinationType

CacheCoordinationType getDefaultCoordinationType()

getSpecifiedCoordinationType

CacheCoordinationType getSpecifiedCoordinationType()

setSpecifiedCoordinationType

void setSpecifiedCoordinationType(CacheCoordinationType newSpecifiedCoordinationType)

getExistenceType

ExistenceType getExistenceType()

This is the combination of defaultExistenceType and specifiedExistenceType. If getSpecifiedExistenceType() returns null, then return getDefaultExistenceType()

getDefaultExistenceType

ExistenceType getDefaultExistenceType()

getSpecifiedExistenceType

ExistenceType getSpecifiedExistenceType()

setSpecifiedExistenceType

void setSpecifiedExistenceType(ExistenceType newSpecifiedExistenceType)

getExpiry

java.lang.Integer getExpiry()

corresponds to the Cache expiry element. If this returns a non-null value then getExpiryTimeOfDay will return null. It is not valid to specify both

setExpiry

void setExpiry(java.lang.Integer expiry)

Setting this to a non-null value will set timeOfDayExpiry to null

Parameters:

expiry -

getExpiryTimeOfDay

ExpiryTimeOfDay getExpiryTimeOfDay()

corresponds to the Cache expiryTimeOfDay annotation or xml element. If this returns a non-null value then getExpiry will return null. It is not valid to specify both.

addExpiryTimeOfDay

ExpiryTimeOfDay addExpiryTimeOfDay()

Add Cache expiryTimeOfDay annotation or xml element, this will set Expiry to null as it is not valid to set both expiry and timeOfDayExpiry

removeExpiryTimeOfDay

void removeExpiryTimeOfDay()

Removes the Cache expiryTimeOfDay annotation/xml element