クラス FaceletCache<V>
- java.lang.ObjectSE
-
- jakarta.faces.view.facelets.FaceletCache<V>
public abstract class FaceletCache<V> extends ObjectSE
この API は、Facelets
ViewDeclarationLanguage
が Facelets のインスタンスを作成してキャッシュする機能を定義します。キャッシュは、ビューフェイスレットとビューメタデータフェイスレットの 2 種類のフェイスレットを処理します。前者は、
UIComponent
ツリーの構築を提供する通常の Facelet です。この種の Facelet には、getFacelet(java.net.URL)
およびisFaceletCached(java.net.URL)
メソッドを介してアクセスします。後者は、ViewDeclarationLanguage.getViewMetadata(jakarta.faces.context.FacesContext, java.lang.String)
に対応する特別な種類の Facelet です。この種の Facelet には、getViewMetadataFacelet(java.net.URL)
およびisViewMetadataFaceletCached(java.net.URL)
メソッドを介してアクセスします。- 導入:
- 2.1
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 クラス 説明 static interface
FaceletCache.MemberFactory<V>
Facelet または View Metadata Facelet インスタンスを作成するためのファクトリインターフェース。
コンストラクターのサマリー
コンストラクター コンストラクター 説明 FaceletCache()
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 abstract V
getFacelet(URLSE url)
キャッシュされた Facelet インスタンスを返します。protected FaceletCache.MemberFactory<V>
getMemberFactory()
protected FaceletCache.MemberFactory<V>
getMetadataMemberFactory()
View MetadataFacelet インスタンスを作成する目的でsetCacheFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>)
に渡されたFaceletCache.MemberFactory
を返します。abstract V
getViewMetadataFacelet(URLSE url)
キャッシュされた ViewMetadataFacelet インスタンスを返します。abstract boolean
isFaceletCached(URLSE url)
この URL にキャッシュされた Facelet インスタンスが存在するかどうかを判別します。abstract boolean
isViewMetadataFaceletCached(URLSE url)
キャッシュされた ViewMetadataFacelet インスタンスがこの URL に存在するかどうかを判別します。void
setCacheFactories(FaceletCache.MemberFactory<V> faceletFactory, FaceletCache.MemberFactory<V> viewMetadataFaceletFactory)
これは、リクエストが処理される前に、起動時にランタイムによって呼び出される必要があり、FaceletCache
実装が、フェイスレットのインスタンスの作成およびメタデータフェイスレットの表示に使用されるFaceletCache.MemberFactory
インスタンスを提供できるようにします。
メソッドの詳細
getFacelet
public abstract V getFacelet(URLSE url) throws IOExceptionSE
キャッシュされた Facelet インスタンスを返します。使用可能なインスタンスがない場合は、Facelet
FaceletCache.MemberFactory
を使用して作成され、キャッシュに保存されます。- パラメーター:
url
- 取得される Facelet のURL
- 戻り値:
- キャッシュされた、または新しい
Facelet
- 例外:
NullPointerExceptionSE
- 引数url
がnull
の場合。IOExceptionSE
- このメソッドのサービスに応答するために必要なファイルをロードできない場合。
isFaceletCached
public abstract boolean isFaceletCached(URLSE url)
この URL にキャッシュされた Facelet インスタンスが存在するかどうかを判別します。キャッシュされたインスタンスが存在する場合は true を返し、存在しない場合は false を返します。
- パラメーター:
url
- フェイスレット用のURL
- 戻り値:
- キャッシュされたインスタンスが存在する場合は true、存在しない場合は false
- 例外:
NullPointerExceptionSE
- 引数url
がnull
の場合。
getViewMetadataFacelet
public abstract V getViewMetadataFacelet(URLSE url) throws IOExceptionSE
キャッシュされた ViewMetadataFacelet インスタンスを返します。使用可能なインスタンスがない場合は、View Metadata Facelet
FaceletCache.MemberFactory
を使用して作成され、キャッシュに保存されます。- パラメーター:
url
- 取得されているビューメタデータフェイスレットのURL
- 戻り値:
- キャッシュされた、または新しいビューメタデータ
Facelet
インスタンス - 例外:
NullPointerExceptionSE
- 引数url
がnull
の場合。IOExceptionSE
- このメソッドのサービスに応答するために必要なファイルをロードできない場合。
isViewMetadataFaceletCached
public abstract boolean isViewMetadataFaceletCached(URLSE url)
キャッシュされた ViewMetadataFacelet インスタンスがこの URL に存在するかどうかを判別します。キャッシュされたインスタンスが存在する場合は true を返し、存在しない場合は false を返します。
- パラメーター:
url
- ビューメタデータフェイスレットのURL
- 戻り値:
- キャッシュされたインスタンスが存在する場合は true、存在しない場合は false
- 例外:
NullPointerExceptionSE
- 引数url
がnull
の場合。
setCacheFactories
public void setCacheFactories(FaceletCache.MemberFactory<V> faceletFactory, FaceletCache.MemberFactory<V> viewMetadataFaceletFactory)
これは、リクエストが処理される前に、起動時にランタイムによって呼び出される必要があり、
FaceletCache
実装が、フェイスレットのインスタンスの作成およびメタデータフェイスレットの表示に使用されるFaceletCache.MemberFactory
インスタンスを提供できるようにします。- パラメーター:
faceletFactory
- Facelets のインスタンスを作成するために使用されるFaceletCache.MemberFactory
インスタンス。viewMetadataFaceletFactory
- メタデータ Facelets のインスタンスを作成するために使用されるFaceletCache.MemberFactory
インスタンス。- 例外:
NullPointerExceptionSE
- いずれかの引数がnull
の場合- 導入:
- 2.3
getMemberFactory
protected FaceletCache.MemberFactory<V> getMemberFactory()
getMetadataMemberFactory
protected FaceletCache.MemberFactory<V> getMetadataMemberFactory()
View MetadataFacelet インスタンスを作成する目的で
setCacheFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>)
に渡されたFaceletCache.MemberFactory
を返します。- 戻り値:
- View MetadataFacelet インスタンスを作成する目的で
setCacheFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>)
に渡されるFaceletCache.MemberFactory
。