クラス 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 interfaceFaceletCache.MemberFactory<V>Facelet または View Metadata Facelet インスタンスを作成するためのファクトリインターフェース。
コンストラクター概要
コンストラクター コンストラクター 説明 FaceletCache()
方法の概要
すべてのメソッド インスタンスメソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 abstract VgetFacelet(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 VgetViewMetadataFacelet(URLSE url)キャッシュされた ViewMetadataFacelet インスタンスを返します。abstract booleanisFaceletCached(URLSE url)この URL にキャッシュされた Facelet インスタンスが存在するかどうかを判別します。abstract booleanisViewMetadataFaceletCached(URLSE url)キャッシュされた ViewMetadataFacelet インスタンスがこの URL に存在するかどうかを判別します。voidsetCacheFactories(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。