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

All Superinterfaces:

Annotation, JavaResourceNode, 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

Version:

2.1

Nested Class Summary

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

JavaResourceNode.Root

Field Summary

static java.lang.String	ALWAYS_REFRESH_PROPERTY
static java.lang.String	ANNOTATION_NAME
static java.lang.String	COORDINATION_TYPE_PROPERTY
static java.lang.String	DISABLE_HITS_PROPERTY
static java.lang.String	EXPIRY_PROPERTY
static java.lang.String	EXPIRY_TIME_OF_DAY_PROPERTY
static java.lang.String	REFRESH_ONLY_IF_NEWER_PROPERTY
static java.lang.String	SHARED_PROPERTY
static java.lang.String	SIZE_PROPERTY
static java.lang.String	TYPE_PROPERTY

Method Summary

TimeOfDayAnnotation	addExpiryTimeOfDay()
java.lang.Boolean	getAlwaysRefresh() Corresponds to the 'alwaysRefresh' element of the Cache annotation.
TextRange	getAlwaysRefreshTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'alwaysRefresh' element.
CacheCoordinationType	getCoordinationType() Corresponds to the 'coordinationType' element of the Cache annotation.
TextRange	getCoordinationTypeTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'coordinationType' element.
java.lang.Boolean	getDisableHits() Corresponds to the 'disableHits' element of the Cache annotation.
TextRange	getDisablesHitsTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'disableHits' element.
java.lang.Integer	getExpiry() Corresponds to the 'expiry' element of the Cache annotation.
TextRange	getExpiryTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'expiry' element.
TimeOfDayAnnotation	getExpiryTimeOfDay() Corresponds to the 'expiryTimeOfDay' element of the Cache annotation.
TextRange	getExpiryTimeOfDayTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'expiryTimeOfDay' element.
java.lang.Boolean	getRefreshOnlyIfNewer() Corresponds to the 'refreshOnlyIfNewer' element of the Cache annotation.
TextRange	getRefreshOnlyIfNewerTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'refreshOnlyIfNewer' element.
java.lang.Boolean	getShared() Corresponds to the 'shared' element of the Cache annotation.
TextRange	getSharedTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'shared' element.
java.lang.Integer	getSize() Corresponds to the 'size' element of the Cache annotation.
TextRange	getSizeTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'size' element.
CacheType	getType() Corresponds to the 'type' element of the Cache annotation.
TextRange	getTypeTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'type' element.
void	removeExpiryTimeOfDay()
void	setAlwaysRefresh(java.lang.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(java.lang.Boolean disableHits) Corresponds to the 'disableHits' element of the Cache annotation.
void	setExpiry(java.lang.Integer expiry) Corresponds to the 'expiry' element of the Cache annotation.
void	setRefreshOnlyIfNewer(java.lang.Boolean refreshOnlyIfNewer) Corresponds to the 'refreshOnlyIfNewer' element of the Cache annotation.
void	setShared(java.lang.Boolean shared) Corresponds to the 'shared' element of the Cache annotation.
void	setSize(java.lang.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.core.resource.java.Annotation

getAnnotationName, getJdtAnnotation, newAnnotation, removeAnnotation

Methods inherited from interface org.eclipse.jpt.core.resource.java.JavaResourceNode

getFile, getJavaResourceCompilationUnit, getRoot, getTextRange, initialize, update

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

Field Detail

ANNOTATION_NAME

static final java.lang.String ANNOTATION_NAME

See Also:

Constant Field Values

TYPE_PROPERTY

static final java.lang.String TYPE_PROPERTY

See Also:

Constant Field Values

SIZE_PROPERTY

static final java.lang.String SIZE_PROPERTY

See Also:

Constant Field Values

SHARED_PROPERTY

static final java.lang.String SHARED_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

ALWAYS_REFRESH_PROPERTY

static final java.lang.String ALWAYS_REFRESH_PROPERTY

See Also:

Constant Field Values

REFRESH_ONLY_IF_NEWER_PROPERTY

static final java.lang.String REFRESH_ONLY_IF_NEWER_PROPERTY

See Also:

Constant Field Values

DISABLE_HITS_PROPERTY

static final java.lang.String DISABLE_HITS_PROPERTY

See Also:

Constant Field Values

COORDINATION_TYPE_PROPERTY

static final java.lang.String COORDINATION_TYPE_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(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getSize

java.lang.Integer getSize()

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

setSize

void setSize(java.lang.Integer size)

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

getSizeTextRange

TextRange getSizeTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getShared

java.lang.Boolean getShared()

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

setShared

void setShared(java.lang.Boolean shared)

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

getSharedTextRange

TextRange getSharedTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getExpiry

java.lang.Integer getExpiry()

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

setExpiry

void setExpiry(java.lang.Integer expiry)

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

getExpiryTextRange

TextRange getExpiryTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getAlwaysRefresh

java.lang.Boolean getAlwaysRefresh()

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

setAlwaysRefresh

void setAlwaysRefresh(java.lang.Boolean alwaysRefresh)

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

getAlwaysRefreshTextRange

TextRange getAlwaysRefreshTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getRefreshOnlyIfNewer

java.lang.Boolean getRefreshOnlyIfNewer()

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

setRefreshOnlyIfNewer

void setRefreshOnlyIfNewer(java.lang.Boolean refreshOnlyIfNewer)

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

getRefreshOnlyIfNewerTextRange

TextRange getRefreshOnlyIfNewerTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getDisableHits

java.lang.Boolean getDisableHits()

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

setDisableHits

void setDisableHits(java.lang.Boolean disableHits)

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

getDisablesHitsTextRange

TextRange getDisablesHitsTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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