AnnotationBasedExpiration (Spring Data for Apache Geode Parent API)

java.lang.ObjectSE
- org.springframework.data.gemfire.expiration.AnnotationBasedExpiration<K,V>

実装済みのインターフェース一覧:
org.apache.geode.cache.CacheCallback, org.apache.geode.cache.CustomExpiry<K,V>, org.apache.geode.cache.Declarable, Aware, BeanFactoryAware
```
public class AnnotationBasedExpiration<K,V>
extends ObjectSE
implements BeanFactoryAware, org.apache.geode.cache.CustomExpiry<K,V>
```
AnnotationBasedExpiration クラスは、Region エントリのクラス型をイントロスペクトし、SDG の有効期限ベースのアノテーションが付けられた Region エントリを反映することによって、Region エントリの Time-To-Live (TTL) または Idle-Timeout (TTI) 有効期限ポリシーを決定する CustomExpiry インターフェースの実装です。
導入:
1.7.0
作成者:
John Blum
関連事項:
AnnotationSE, BeanFactory, BeanFactoryAware, ExpirationActionType, Expiration, IdleTimeoutExpiration, TimeToLiveExpiration, CustomExpiry、ExpirationAction、ExpirationAttributes、Region

ネストされたクラスの概要

ネストされたクラス
修飾子と型	クラスと説明
`protected static class`	`AnnotationBasedExpiration.ExpirationMetaData` ExpirationMetaData クラスは、有効期限のタイムアウトや有効期限が発生したときに実行されるアクションなど、有効期限ポリシーを構成する設定をカプセル化します。

フィールド概要

フィールド
修飾子と型	フィールドと説明
`protected static AtomicReferenceSE<BeanFactory>`	`BEAN_FACTORY_REFERENCE`
`protected static AtomicReferenceSE<StandardEvaluationContext>`	`EVALUATION_CONTEXT_REFERENCE`

コンストラクター概要

コンストラクター
コンストラクターと説明
`AnnotationBasedExpiration()` デフォルトの有効期限ポリシーのない AnnotationBasedExpiration クラスの新しいインスタンスを構築します。
`AnnotationBasedExpiration(org.apache.geode.cache.ExpirationAttributes defaultExpirationAttributes)` 特定のデフォルトの有効期限ポリシーで初期化された `AnnotationBasedExpiration` の新しいインスタンスを構築します。

方法の概要

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`close()` このコールバックを含むリージョンが閉じられたり破棄されたりしたとき、キャッシュが閉じられたとき、AttributesMutator を使用してリージョンからコールバックが削除されたときに呼び出されます。
`static <K,V> AnnotationBasedExpiration<K,V>`	`forIdleTimeout()` アイドルタイムアウト (TTI) 有効期限を使用して期限切れのアノテーション付き `Region` エントリを処理するために、デフォルトの `ExpirationAttributes` を持たない `AnnotationBasedExpiration` のインスタンスを構築するために使用されるファクトリメソッド。
`static <K,V> AnnotationBasedExpiration<K,V>`	`forIdleTimeout(org.apache.geode.cache.ExpirationAttributes defaultExpirationAttributes)` アイドルタイムアウト (TTI) の有効期限を使用して、期限切れのアノテーション付き `Region` エントリを処理するために、デフォルトの `ExpirationAttributes` で初期化された `AnnotationBasedExpiration` のインスタンスを構築するために使用されるファクトリメソッド。
`static <K,V> AnnotationBasedExpiration<K,V>`	`forTimeToLive()` Time-To-Live (TTL) 有効期限を使用して期限切れのアノテーション付き `Region` エントリを処理するために、デフォルトの `ExpirationAttributes` を持たない `AnnotationBasedExpiration` のインスタンスを構築するために使用されるファクトリメソッド。
`static <K,V> AnnotationBasedExpiration<K,V>`	`forTimeToLive(org.apache.geode.cache.ExpirationAttributes defaultExpirationAttributes)` デフォルトの `ExpirationAttributes` で初期化された `AnnotationBasedExpiration` のインスタンスを構築し、Time-To-Live (TTL) 有効期限を使用して期限切れのアノテーション付き `Region` エントリを処理するために使用されるファクトリメソッド。
`protected BeanFactory`	`getBeanFactory()` この `AnnotationBasedExpiration` Bean が管理されている Spring `BeanFactory` への参照を取得します。
`protected org.apache.geode.cache.ExpirationAttributes`	`getDefaultExpirationAttributes()` アプリケーションドメインオブジェクト固有の有効期限メタデータが指定されていない場合に、デフォルトで使用される有効期限ポリシーを取得します。
`protected Expiration`	`getExpiration(org.apache.geode.cache.Region.Entry<K, V> entry)` リージョンエントリから有効期限アノテーションメタデータを取得します。
`protected AnnotationBasedExpiration.ExpirationMetaData`	`getExpirationMetaData(org.apache.geode.cache.Region.Entry<K, V> entry)` 指定された `Region` エントリのカスタム有効期限 (アノテーションベース) ポリシーメタデータを取得します。
`org.apache.geode.cache.ExpirationAttributes`	`getExpiry(org.apache.geode.cache.Region.Entry<K, V> entry)` 指定されたエントリの有効期限を計算します。
`protected IdleTimeoutExpiration`	`getIdleTimeout(org.apache.geode.cache.Region.Entry<K, V> entry)` リージョンエントリから IdleTimeoutExpiration アノテーションメタデータを取得します。
`protected TimeToLiveExpiration`	`getTimeToLive(org.apache.geode.cache.Region.Entry<K, V> entry)` リージョンエントリから TimeToLiveExpiration アノテーションメタデータを取得します。
`protected void`	`initEvaluationContext()` 有効期限アノテーション属性値のプロパティプレースホルダーと SpEL 式を解析するために使用される Spring 式言語 (SpEL) `EvaluationContext` を初期化します。
`protected boolean`	`isExpirationConfigured(org.apache.geode.cache.Region.Entry<K, V> entry)` リージョンエントリに有効期限アノテーションが付けられているかどうかを判断します。
`protected boolean`	`isIdleTimeoutConfigured(org.apache.geode.cache.Region.Entry<K, V> entry)` リージョンエントリに IdleTimeoutExpiration アノテーションが付けられているかどうかを判断します。
`protected boolean`	`isTimeToLiveConfigured(org.apache.geode.cache.Region.Entry<K, V> entry)` リージョンエントリに TimeToLiveExpiration アノテーションが付けられているかどうかを判断します。
`protected org.apache.geode.cache.ExpirationAttributes`	`newExpirationAttributes(AnnotationBasedExpiration.ExpirationMetaData expirationMetaData)` アプリケーションドメインオブジェクト固有の有効期限ポリシーで構成された `ExpirationAttributes` の新しいインスタンスを構築します。
`void`	`setBeanFactory(BeanFactory beanFactory)` Spring コンテキストでこの `AnnotationBasedExpiration` Bean を管理する `BeanFactory` を設定します。
`void`	`setDefaultExpirationAttributes(org.apache.geode.cache.ExpirationAttributes defaultExpirationAttributes)` アプリケーションドメインオブジェクト固有の有効期限メタデータが指定されていない場合に、デフォルトで使用する有効期限ポリシーを設定します。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース org.apache.geode.cache.Declarable から継承されたメソッド
init, initialize

- フィールドの詳細
  - BEAN_FACTORY_REFERENCE
```
protected static final AtomicReferenceSE<BeanFactory> BEAN_FACTORY_REFERENCE
```
  - EVALUATION_CONTEXT_REFERENCE
```
protected static final AtomicReferenceSE<StandardEvaluationContext> EVALUATION_CONTEXT_REFERENCE
```
- コンストラクターの詳細
  - AnnotationBasedExpiration
```
public AnnotationBasedExpiration()
```
    デフォルトの有効期限ポリシーのない AnnotationBasedExpiration クラスの新しいインスタンスを構築します。
  - AnnotationBasedExpiration
```
public AnnotationBasedExpiration(org.apache.geode.cache.ExpirationAttributes defaultExpirationAttributes)
```
    特定のデフォルトの有効期限ポリシーで初期化された AnnotationBasedExpiration の新しいインスタンスを構築します。
    パラメーター:
    defaultExpirationAttributes - デフォルトの有効期限ポリシーとして使用される有効期限設定。
    関連事項:
    ExpirationAttributes
- メソッドの詳細
  - forIdleTimeout
```
public static <K,V> AnnotationBasedExpiration<K,V> forIdleTimeout()
```
    アイドルタイムアウト (TTI) 有効期限を使用して期限切れのアノテーション付き Region エントリを処理するために、デフォルトの ExpirationAttributes を持たない AnnotationBasedExpiration のインスタンスを構築するために使用されるファクトリメソッド。
    型パラメーター:
    K - Region エントリキーの ClassSE 型。
    V - Region エントリ値の ClassSE 型。
    戻り値:
    アイドルタイムアウトの有効期限を使用して、期限切れのアノテーション付き Region エントリを処理する AnnotationBasedExpiration インスタンス。
    関連事項:
    AnnotationBasedExpiration, IdleTimeoutExpiration, forIdleTimeout(org.apache.geode.cache.ExpirationAttributes)
  - forIdleTimeout
```
public static <K,V> AnnotationBasedExpiration<K,V> forIdleTimeout(org.apache.geode.cache.ExpirationAttributes defaultExpirationAttributes)
```
    アイドルタイムアウト (TTI) の有効期限を使用して、期限切れのアノテーション付き Region エントリを処理するために、デフォルトの ExpirationAttributes で初期化された AnnotationBasedExpiration のインスタンスを構築するために使用されるファクトリメソッド。
    型パラメーター:
    K - Region エントリキーの ClassSE 型。
    V - Region エントリ値の ClassSE 型。
    パラメーター:
    defaultExpirationAttributes - Region に有効期限ポリシーが指定されていない場合は、デフォルトで ExpirationAttributes が使用されます。
    戻り値:
    アイドルタイムアウトの有効期限を使用して、期限切れのアノテーション付き Region エントリを処理する AnnotationBasedExpiration インスタンス。
    関連事項:
    AnnotationBasedExpiration, IdleTimeoutExpiration, AnnotationBasedExpiration(ExpirationAttributes)
  - forTimeToLive
```
public static <K,V> AnnotationBasedExpiration<K,V> forTimeToLive()
```
    Time-To-Live (TTL) 有効期限を使用して期限切れのアノテーション付き Region エントリを処理するために、デフォルトの ExpirationAttributes を持たない AnnotationBasedExpiration のインスタンスを構築するために使用されるファクトリメソッド。
    型パラメーター:
    K - Region エントリキーの ClassSE 型。
    V - Region エントリ値の ClassSE 型。
    戻り値:
    Time-To-Live 有効期限を使用して、期限切れのアノテーション付き Region エントリを処理する AnnotationBasedExpiration インスタンス。
    関連事項:
    AnnotationBasedExpiration, TimeToLiveExpiration, forTimeToLive(org.apache.geode.cache.ExpirationAttributes)
  - forTimeToLive
```
public static <K,V> AnnotationBasedExpiration<K,V> forTimeToLive(org.apache.geode.cache.ExpirationAttributes defaultExpirationAttributes)
```
    デフォルトの ExpirationAttributes で初期化された AnnotationBasedExpiration のインスタンスを構築し、Time-To-Live (TTL) 有効期限を使用して期限切れのアノテーション付き Region エントリを処理するために使用されるファクトリメソッド。
    型パラメーター:
    K - Region エントリキーの ClassSE 型。
    V - Region エントリ値の ClassSE 型。
    パラメーター:
    defaultExpirationAttributes - Region に有効期限ポリシーが指定されていない場合は、デフォルトで ExpirationAttributes が使用されます。
    戻り値:
    Time-To-Live 有効期限を使用して、期限切れのアノテーション付き Region エントリを処理する AnnotationBasedExpiration インスタンス。
    関連事項:
    AnnotationBasedExpiration, TimeToLiveExpiration, AnnotationBasedExpiration(ExpirationAttributes)
  - initEvaluationContext
```
protected void initEvaluationContext()
```
    有効期限アノテーション属性値のプロパティプレースホルダーと SpEL 式を解析するために使用される Spring 式言語 (SpEL) EvaluationContext を初期化します。
  - setBeanFactory
```
public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException
```
    Spring コンテキストでこの AnnotationBasedExpiration Bean を管理する BeanFactory を設定します。
    次で指定:
    インターフェース BeanFactoryAware 内の setBeanFactory
    パラメーター:
    beanFactory - この Bean が属する Spring BeanFactory。
    例外:
    BeansException - BeanFactory 参照を初期化できない場合。
    関連事項:
    BeanFactory, initEvaluationContext()
  - getBeanFactory
```
protected BeanFactory getBeanFactory()
```
    この AnnotationBasedExpiration Bean が管理されている Spring BeanFactory への参照を取得します。
    戻り値:
    Spring BeanFactory への参照。
    例外:
    IllegalStateExceptionSE - BeanFactory 参照が適切に初期化されなかった場合。
    関連事項:
    BeanFactory
  - setDefaultExpirationAttributes
```
public void setDefaultExpirationAttributes(org.apache.geode.cache.ExpirationAttributes defaultExpirationAttributes)
```
    アプリケーションドメインオブジェクト固有の有効期限メタデータが指定されていない場合に、デフォルトで使用する有効期限ポリシーを設定します。
    パラメーター:
    defaultExpirationAttributes - デフォルトの有効期限ポリシーとして使用される有効期限設定。
    関連事項:
    getDefaultExpirationAttributes(), ExpirationAttributes
  - getDefaultExpirationAttributes
```
protected org.apache.geode.cache.ExpirationAttributes getDefaultExpirationAttributes()
```
    アプリケーションドメインオブジェクト固有の有効期限メタデータが指定されていない場合に、デフォルトで使用される有効期限ポリシーを取得します。
    戻り値:
    デフォルトの有効期限ポリシーを定義する有効期限設定を持つ ExpirationAttributes のインスタンス。
    関連事項:
    setDefaultExpirationAttributes(org.apache.geode.cache.ExpirationAttributes), ExpirationAttributes
  - getExpiry
```
public org.apache.geode.cache.ExpirationAttributes getExpiry(org.apache.geode.cache.Region.Entry<K,V> entry)
```
    指定されたエントリの有効期限を計算します。null を返すと、Region のデフォルトが使用されることを示します。このメソッドの呼び出しが完了した後は、エントリパラメーターを使用しないでください。
    次で指定:
    インターフェース org.apache.geode.cache.CustomExpiry<K, V> 内の getExpiry
    パラメーター:
    entry - 適切な有効期限ポリシーを決定するために使用されるエントリ。
    戻り値:
    使用する有効期限設定、またはリージョンのデフォルトを使用する場合は null。
    関連事項:
    ExpirationAttributes, Region, getExpirationMetaData(Region.Entry), newExpirationAttributes(ExpirationMetaData)
  - getExpirationMetaData
```
protected AnnotationBasedExpiration.ExpirationMetaData getExpirationMetaData(org.apache.geode.cache.Region.Entry<K,V> entry)
```
    指定された Region エントリのカスタム有効期限 (アノテーションベース) ポリシーメタデータを取得します。
    パラメーター:
    entry - 有効期限ポリシーメタデータのソースとして使用される Region エントリ。
    戻り値:
    Region エントリから抽出された AnnotationBasedExpiration.ExpirationMetaData、または有効期限ポリシーメタデータを Region エントリから判別できなかった場合は null。
    関連事項:
    AnnotationBasedExpiration.ExpirationMetaData
  - newExpirationAttributes
```
protected org.apache.geode.cache.ExpirationAttributes newExpirationAttributes(AnnotationBasedExpiration.ExpirationMetaData expirationMetaData)
```
    アプリケーションドメインオブジェクト固有の有効期限ポリシーで構成された ExpirationAttributes の新しいインスタンスを構築します。アプリケーションドメインオブジェクト型にカスタム有効期限メタデータがアノテーション付けされていない場合は、デフォルトの有効期限設定が使用されます。
    パラメーター:
    expirationMetaData - ExpirationAttributes の構築に使用されるアプリケーションドメインオブジェクト固有の有効期限ポリシーメタデータ。
    戻り値:
    アプリケーションドメインオブジェクト固有の有効期限ポリシーから構成されたカスタム ExpirationAttributes、またはアプリケーションドメインオブジェクトにカスタム有効期限メタデータがアノテーション付けされていない場合はデフォルトの有効期限設定。
    関連事項:
    AnnotationBasedExpiration.ExpirationMetaData, ExpirationAttributes, getDefaultExpirationAttributes()
  - isExpirationConfigured
```
protected boolean isExpirationConfigured(org.apache.geode.cache.Region.Entry<K,V> entry)
```
    リージョンエントリに有効期限アノテーションが付けられているかどうかを判断します。
    パラメーター:
    entry - Region.Entry を使用して有効期限アノテーションの存在を評価します。
    戻り値:
    リージョンエントリに @Expiration がアノテーションされているかどうかを示すブール値。
    関連事項:
    Expiration, isAnnotationPresent(Object, Class)
  - getExpiration
```
protected Expiration getExpiration(org.apache.geode.cache.Region.Entry<K,V> entry)
```
    リージョンエントリから有効期限アノテーションメタデータを取得します。
    パラメーター:
    entry - 有効期限アノテーションメタデータを抽出する Region.Entry。
    戻り値:
    指定されたリージョンエントリの有効期限アノテーションメタデータ、またはリージョンエントリに @Expiration アノテーションが付けられていない場合は null。
    関連事項:
    Expiration, getAnnotation(Object, Class)
  - isIdleTimeoutConfigured
```
protected boolean isIdleTimeoutConfigured(org.apache.geode.cache.Region.Entry<K,V> entry)
```
    リージョンエントリに IdleTimeoutExpiration アノテーションが付けられているかどうかを判断します。
    パラメーター:
    entry - Region.Entry を使用して、IdleTimeoutExpiration アノテーションの存在を評価します。
    戻り値:
    リージョンエントリに @IdleTimeoutExpiration がアノテーションされているかどうかを示すブール値。
    関連事項:
    IdleTimeoutExpiration, isAnnotationPresent(Object, Class)
  - getIdleTimeout
```
protected IdleTimeoutExpiration getIdleTimeout(org.apache.geode.cache.Region.Entry<K,V> entry)
```
    リージョンエントリから IdleTimeoutExpiration アノテーションメタデータを取得します。
    パラメーター:
    entry - IdleTimeoutExpiration アノテーションメタデータを抽出する Region.Entry。
    戻り値:
    指定されたリージョンエントリの IdleTimeoutExpiration アノテーションメタデータ、またはリージョンエントリが @IdleTimeoutExpiration でアノテーションされていない場合は null。
    関連事項:
    IdleTimeoutExpiration, getAnnotation(Object, Class)
  - isTimeToLiveConfigured
```
protected boolean isTimeToLiveConfigured(org.apache.geode.cache.Region.Entry<K,V> entry)
```
    リージョンエントリに TimeToLiveExpiration アノテーションが付けられているかどうかを判断します。
    パラメーター:
    entry - Region.Entry を使用して、TimeToLiveExpiration アノテーションの存在を評価します。
    戻り値:
    リージョンエントリに @TimeToLiveExpiration がアノテーションされているかどうかを示すブール値。
    関連事項:
    TimeToLiveExpiration, isAnnotationPresent(Object, Class)
  - getTimeToLive
```
protected TimeToLiveExpiration getTimeToLive(org.apache.geode.cache.Region.Entry<K,V> entry)
```
    リージョンエントリから TimeToLiveExpiration アノテーションメタデータを取得します。
    パラメーター:
    entry - TimeToLiveExpiration アノテーションメタデータを抽出する Region.Entry。
    戻り値:
    指定されたリージョンエントリの TimeToLiveExpiration アノテーションメタデータ、またはリージョンエントリが @TimeToLiveExpiration でアノテーションされていない場合は null。
    関連事項:
    TimeToLiveExpiration, getAnnotation(Object, Class)
  - close
```
public void close()
```
    このコールバックを含むリージョンが閉じられたり破棄されたりしたとき、キャッシュが閉じられたとき、AttributesMutator を使用してリージョンからコールバックが削除されたときに呼び出されます。
    次で指定:
    インターフェース org.apache.geode.cache.CacheCallback 内の close

クラス AnnotationBasedExpiration<K,V>

ネストされたクラスの概要

フィールド概要

コンストラクター概要

方法の概要

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.apache.geode.cache.Declarable から継承されたメソッド

フィールドの詳細

BEAN_FACTORY_REFERENCE

EVALUATION_CONTEXT_REFERENCE

コンストラクターの詳細

AnnotationBasedExpiration

AnnotationBasedExpiration

メソッドの詳細

forIdleTimeout

forIdleTimeout

forTimeToLive

forTimeToLive

initEvaluationContext

setBeanFactory

getBeanFactory

setDefaultExpirationAttributes

getDefaultExpirationAttributes

getExpiry

getExpirationMetaData

newExpirationAttributes

isExpirationConfigured

getExpiration

isIdleTimeoutConfigured

getIdleTimeout

isTimeToLiveConfigured

getTimeToLive

close