org.eclipse.jpt.jpa.eclipselink.core.resource.java
Interface CacheAnnotation

All Superinterfaces:

Annotation, JavaResourceModel, Model

public interface CacheAnnotation
extends Annotation

Corresponds to the EclipseLink annotation org.eclipse.persistence.annotations.Cache

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceModel

JavaResourceModel.FileTransformer, JavaResourceModel.Root

Field Summary

static String	ALWAYS_REFRESH_PROPERTY
static String	ANNOTATION_NAME
static String	COORDINATION_TYPE_PROPERTY
static String	DISABLE_HITS_PROPERTY
static String	EXPIRY_PROPERTY
static String	EXPIRY_TIME_OF_DAY_PROPERTY
static String	ISOLATION_PROPERTY
static String	REFRESH_ONLY_IF_NEWER_PROPERTY
static String	SHARED_PROPERTY
static String	SIZE_PROPERTY
static String	TYPE_PROPERTY

Fields inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceModel

FILE_TRANSFORMER

Method Summary

TimeOfDayAnnotation	addExpiryTimeOfDay()
Boolean	getAlwaysRefresh() Corresponds to the 'alwaysRefresh' element of the Cache annotation.
TextRange	getAlwaysRefreshTextRange() Return the TextRange for the 'alwaysRefresh' element.
CacheCoordinationType	getCoordinationType() Corresponds to the 'coordinationType' element of the Cache annotation.
TextRange	getCoordinationTypeTextRange() Return the TextRange for the 'coordinationType' element.
Boolean	getDisableHits() Corresponds to the 'disableHits' element of the Cache annotation.
TextRange	getDisableHitsTextRange() Return the TextRange for the 'disableHits' element.
Integer	getExpiry() Corresponds to the 'expiry' element of the Cache annotation.
TextRange	getExpiryTextRange() Return the TextRange for the 'expiry' element.
TimeOfDayAnnotation	getExpiryTimeOfDay() Corresponds to the 'expiryTimeOfDay' element of the Cache annotation.
TextRange	getExpiryTimeOfDayTextRange() Return the TextRange for the 'expiryTimeOfDay' element.
CacheIsolationType2_2	getIsolation() Corresponds to the 'isolation' element of the Cache annotation.
TextRange	getIsolationTextRange() Return the TextRange for the 'isolation' element.
Boolean	getRefreshOnlyIfNewer() Corresponds to the 'refreshOnlyIfNewer' element of the Cache annotation.
TextRange	getRefreshOnlyIfNewerTextRange() Return the TextRange for the 'refreshOnlyIfNewer' element.
Boolean	getShared() Corresponds to the 'shared' element of the Cache annotation.
TextRange	getSharedTextRange() Return the TextRange for the 'shared' element.
Integer	getSize() Corresponds to the 'size' element of the Cache annotation.
TextRange	getSizeTextRange() Return the TextRange for the 'size' element.
CacheType	getType() Corresponds to the 'type' element of the Cache annotation.
TextRange	getTypeTextRange() Return the TextRange for the 'type' element.
void	removeExpiryTimeOfDay()
void	setAlwaysRefresh(Boolean alwaysRefresh) Corresponds to the 'alwaysRefresh' element of the Cache annotation.
void	setCoordinationType(CacheCoordinationType coordinationType) Corresponds to the 'coordinationType' element of the Cache annotation.
void	setDisableHits(Boolean disableHits) Corresponds to the 'disableHits' element of the Cache annotation.
void	setExpiry(Integer expiry) Corresponds to the 'expiry' element of the Cache annotation.
void	setIsolation(CacheIsolationType2_2 isolation) Corresponds to the 'isolation' element of the Cache annotation.
void	setRefreshOnlyIfNewer(Boolean refreshOnlyIfNewer) Corresponds to the 'refreshOnlyIfNewer' element of the Cache annotation.
void	setShared(Boolean shared) Corresponds to the 'shared' element of the Cache annotation.
void	setSize(Integer size) Corresponds to the 'size' element of the Cache annotation.
void	setType(CacheType type) Corresponds to the 'type' element of the Cache annotation.

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.Annotation

getAnnotationName, getAstAnnotation, initialize, initialize, isUnset, newAnnotation, removeAnnotation, synchronizeWith, synchronizeWith

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceModel

getFile, getJavaResourceCompilationUnit, getParent, getRoot, getTextRange

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

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Field Detail

ANNOTATION_NAME

static final String ANNOTATION_NAME

See Also:

Constant Field Values

TYPE_PROPERTY

static final String TYPE_PROPERTY

See Also:

Constant Field Values

SIZE_PROPERTY

static final String SIZE_PROPERTY

See Also:

Constant Field Values

SHARED_PROPERTY

static final String SHARED_PROPERTY

See Also:

Constant Field Values

EXPIRY_PROPERTY

static final String EXPIRY_PROPERTY

See Also:

Constant Field Values

EXPIRY_TIME_OF_DAY_PROPERTY

static final String EXPIRY_TIME_OF_DAY_PROPERTY

See Also:

Constant Field Values

ALWAYS_REFRESH_PROPERTY

static final String ALWAYS_REFRESH_PROPERTY

See Also:

Constant Field Values

REFRESH_ONLY_IF_NEWER_PROPERTY

static final String REFRESH_ONLY_IF_NEWER_PROPERTY

See Also:

Constant Field Values

DISABLE_HITS_PROPERTY

static final String DISABLE_HITS_PROPERTY

See Also:

Constant Field Values

COORDINATION_TYPE_PROPERTY

static final String COORDINATION_TYPE_PROPERTY

See Also:

Constant Field Values

ISOLATION_PROPERTY

static final String ISOLATION_PROPERTY

See Also:

Constant Field Values

Method Detail

getType

CacheType getType()

Corresponds to the 'type' element of the Cache annotation. Return null if the element does not exist in Java.

setType

void setType(CacheType type)

Corresponds to the 'type' element of the Cache annotation. Set to null to remove the element.

getTypeTextRange

TextRange getTypeTextRange()

Return the TextRange for the 'type' element. If the element does not exist return the TextRange for the Cache annotation.

getSize

Integer getSize()

Corresponds to the 'size' element of the Cache annotation. Return null if the element does not exist in Java.

setSize

void setSize(Integer size)

Corresponds to the 'size' element of the Cache annotation. Set to null to remove the element.

getSizeTextRange

TextRange getSizeTextRange()

Return the TextRange for the 'size' element. If the element does not exist return the TextRange for the Cache annotation.

getShared

Boolean getShared()

Corresponds to the 'shared' element of the Cache annotation. Return null if the element does not exist in Java.

setShared

void setShared(Boolean shared)

Corresponds to the 'shared' element of the Cache annotation. Set to null to remove the element.

getSharedTextRange

TextRange getSharedTextRange()

Return the TextRange for the 'shared' element. If the element does not exist return the TextRange for the Cache annotation.

getExpiry

Integer getExpiry()

Corresponds to the 'expiry' element of the Cache annotation. Return null if the element does not exist in Java.

setExpiry

void setExpiry(Integer expiry)

Corresponds to the 'expiry' element of the Cache annotation. Set to null to remove the element.

getExpiryTextRange

TextRange getExpiryTextRange()

Return the TextRange for the 'expiry' element. If the element does not exist return the TextRange for the Cache annotation.

getExpiryTimeOfDay

TimeOfDayAnnotation getExpiryTimeOfDay()

Corresponds to the 'expiryTimeOfDay' element of the Cache annotation. Return null if the element does not exist in Java.

addExpiryTimeOfDay

TimeOfDayAnnotation addExpiryTimeOfDay()

removeExpiryTimeOfDay

void removeExpiryTimeOfDay()

getExpiryTimeOfDayTextRange

TextRange getExpiryTimeOfDayTextRange()

Return the TextRange for the 'expiryTimeOfDay' element. If the element does not exist return the TextRange for the Cache annotation.

getAlwaysRefresh

Boolean getAlwaysRefresh()

Corresponds to the 'alwaysRefresh' element of the Cache annotation. Return null if the element does not exist in Java.

setAlwaysRefresh

void setAlwaysRefresh(Boolean alwaysRefresh)

Corresponds to the 'alwaysRefresh' element of the Cache annotation. Set to null to remove the element.

getAlwaysRefreshTextRange

TextRange getAlwaysRefreshTextRange()

Return the TextRange for the 'alwaysRefresh' element. If the element does not exist return the TextRange for the Cache annotation.

getRefreshOnlyIfNewer

Boolean getRefreshOnlyIfNewer()

Corresponds to the 'refreshOnlyIfNewer' element of the Cache annotation. Return null if the element does not exist in Java.

setRefreshOnlyIfNewer

void setRefreshOnlyIfNewer(Boolean refreshOnlyIfNewer)

Corresponds to the 'refreshOnlyIfNewer' element of the Cache annotation. Set to null to remove the element.

getRefreshOnlyIfNewerTextRange

TextRange getRefreshOnlyIfNewerTextRange()

Return the TextRange for the 'refreshOnlyIfNewer' element. If the element does not exist return the TextRange for the Cache annotation.

getDisableHits

Boolean getDisableHits()

Corresponds to the 'disableHits' element of the Cache annotation. Return null if the element does not exist in Java.

setDisableHits

void setDisableHits(Boolean disableHits)

Corresponds to the 'disableHits' element of the Cache annotation. Set to null to remove the element.

getDisableHitsTextRange

TextRange getDisableHitsTextRange()

Return the TextRange for the 'disableHits' element. If the element does not exist return the TextRange for the Cache annotation.

getCoordinationType

CacheCoordinationType getCoordinationType()

Corresponds to the 'coordinationType' element of the Cache annotation. Return null if the element does not exist in Java.

setCoordinationType

void setCoordinationType(CacheCoordinationType coordinationType)

Corresponds to the 'coordinationType' element of the Cache annotation. Set to null to remove the element.

getCoordinationTypeTextRange

TextRange getCoordinationTypeTextRange()

Return the TextRange for the 'coordinationType' element. If the element does not exist return the TextRange for the Cache annotation.

getIsolation

CacheIsolationType2_2 getIsolation()

Corresponds to the 'isolation' element of the Cache annotation. Return null if the element does not exist in Java.

setIsolation

void setIsolation(CacheIsolationType2_2 isolation)

Corresponds to the 'isolation' element of the Cache annotation. Set to null to remove the element.

getIsolationTextRange

TextRange getIsolationTextRange()

Return the TextRange for the 'isolation' element. If the element does not exist return the TextRange for the Cache annotation.