クラス ResourceHandlerWrapper
- java.lang.ObjectSE
-
- jakarta.faces.application.ResourceHandler
-
- jakarta.faces.application.ResourceHandlerWrapper
- 実装されたすべてのインターフェース:
FacesWrapper<ResourceHandler>
public abstract class ResourceHandlerWrapper extends ResourceHandler implements FacesWrapper<ResourceHandler>
既存の
ResourceHandler
インスタンスに特殊な動作を提供したい開発者によってサブクラス化することができるResourceHandler
の簡単な実装を提供します。すべてのメソッドのデフォルトの実装では、ラップされたResourceHandler
を呼び出します。使用方法: このクラスを継承し、ラップされている実装をコンストラクターにプッシュし、
getWrapped()
を使用してラップされているインスタンスにアクセスします。- 導入:
- 2.0
フィールドサマリー
クラス jakarta.faces.application.ResourceHandler から継承されたフィールド
FACES_SCRIPT_LIBRARY_NAME, FACES_SCRIPT_RESOURCE_NAME, JSF_SCRIPT_LIBRARY_NAME, JSF_SCRIPT_RESOURCE_NAME, LOCALE_PREFIX, RESOURCE_CONTRACT_XML, RESOURCE_EXCLUDES_DEFAULT_VALUE, RESOURCE_EXCLUDES_PARAM_NAME, RESOURCE_IDENTIFIER, WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME, WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME
コンストラクターのサマリー
コンストラクター コンストラクター 説明 ResourceHandlerWrapper()
使用すべきではありません。ラップされている実装を使用する他のコンストラクターを使用します。ResourceHandlerWrapper(ResourceHandler wrapped)
このリソースハンドラーが装飾されている場合、装飾を行う実装は、ラップされる実装をこのコンストラクターにプッシュする必要があります。
メソッドのサマリー
コンストラクターの詳細
ResourceHandlerWrapper
@DeprecatedSE public ResourceHandlerWrapper()
使用すべきではありません。ラップされている実装を使用する他のコンストラクターを使用します。
ResourceHandlerWrapper
public ResourceHandlerWrapper(ResourceHandler wrapped)
このリソースハンドラーが装飾されている場合、装飾を行う実装は、ラップされている実装をこのコンストラクターにプッシュする必要があります。
getWrapped()
は、ラップされている実装を返します。- パラメーター:
wrapped
- ラップされる実装。- 導入:
- 2.3
メソッドの詳細
getWrapped
public ResourceHandler getWrapped()
インターフェースからコピーされた説明:FacesWrapper
このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。
- 次で指定:
- インターフェース
FacesWrapper<ResourceHandler>
のgetWrapped
- 戻り値:
- ラップされたインスタンス。
createResource
public Resource createResource(StringSE resourceName)
このメソッドのデフォルトの動作は、ラップされた
ResourceHandler
オブジェクトでResourceHandler.createResource(String)
を呼び出すことです。- 次で指定:
- クラス
ResourceHandler
のcreateResource
- パラメーター:
resourceName
- リソースの名前。- 戻り値:
- 新しく作成された
Resource
インスタンス。指定されたリソースのエンコードまたはデコードでの使用に適しています。
createResourceFromId
public Resource createResourceFromId(StringSE resourceId)
このメソッドのデフォルトの動作は、ラップされた
ResourceHandler
オブジェクトでResourceHandler.createResourceFromId(String)
を呼び出すことです。- オーバーライド:
- クラス
ResourceHandler
のcreateResourceFromId
- パラメーター:
resourceId
- リソースのリソース識別子。- 戻り値:
- 新しく作成された
Resource
インスタンス。指定されたリソースのエンコードまたはデコードでの使用に適しています。 - 導入:
- 2.2
createResource
public Resource createResource(StringSE resourceName, StringSE libraryName)
このメソッドのデフォルトの動作は、ラップされた
ResourceHandler
オブジェクトでResourceHandler.createResource(String, String)
を呼び出すことです。- 次で指定:
- クラス
ResourceHandler
のcreateResource
- パラメーター:
resourceName
- リソースの名前。libraryName
- このリソースが存在するライブラリ (または契約) の名前はnull
の場合があります。リソースライブラリの名前とリソースライブラリ契約が競合する場合は、リソースライブラリが優先されます。"../" などの相対パスを含めることはできません。- 戻り値:
- 新しく作成された
Resource
インスタンス。指定されたリソースのエンコードまたはデコードでの使用に適しています。
createViewResource
public ViewResource createViewResource(FacesContext context, StringSE resourceName)
このメソッドのデフォルトの動作は、ラップされた
ResourceHandler
オブジェクトでResourceHandler.createViewResource(jakarta.faces.context.FacesContext, java.lang.String)
を呼び出すことです。- オーバーライド:
- クラス
ResourceHandler
のcreateViewResource
- パラメーター:
context
- このリクエストのFacesContext
resourceName
-ViewDeclarationLanguage
によってビューとして解釈されるリソースの名前。- 戻り値:
- 新しく作成された
ViewResource
インスタンス。ViewDeclarationLanguage
での使用に適しています。
getViewResources
public StreamSE<StringSE> getViewResources(FacesContext facesContext, StringSE path, int maxDepth, ResourceVisitOption... options)
このメソッドのデフォルトの動作は、ラップされた
ResourceHandler
オブジェクトでResourceHandler.getViewResources(FacesContext, String, int, ResourceVisitOption...)
を呼び出すことです。- オーバーライド:
- クラス
ResourceHandler
のgetViewResources
- パラメーター:
facesContext
- このリクエストのFacesContext
。path
- ビューリソースの検索を開始する最初のパスmaxDepth
- ルート(/
)から数えた、アクセスするネストされたディレクトリの絶対最大深度。options
- トラバーサルに影響を与えるオプション。これらの詳細については、ResourceVisitOption
を参照してください。- 戻り値:
- ビューリソース名の
Stream
SE - 導入:
- 2.3
getViewResources
public StreamSE<StringSE> getViewResources(FacesContext facesContext, StringSE path, ResourceVisitOption... options)
このメソッドのデフォルトの動作は、ラップされた
ResourceHandler
オブジェクトでResourceHandler.getViewResources(FacesContext, String, ResourceVisitOption...)
を呼び出すことです。- オーバーライド:
- クラス
ResourceHandler
のgetViewResources
- パラメーター:
facesContext
- このリクエストのFacesContext
。path
- ビューリソースの検索を開始する最初のパスoptions
- トラバーサルに影響を与えるオプション。これらの詳細については、ResourceVisitOption
を参照してください。- 戻り値:
- ビューリソース名の
Stream
SE - 導入:
- 2.3
createResource
public Resource createResource(StringSE resourceName, StringSE libraryName, StringSE contentType)
このメソッドのデフォルトの動作は、ラップされた
ResourceHandler
オブジェクトでResourceHandler.createResource(String, String, String)
を呼び出すことです。- 次で指定:
- クラス
ResourceHandler
のcreateResource
- パラメーター:
resourceName
- リソースの名前。libraryName
- このリソースが存在するライブラリの名前。null
の場合があります。 "../" などの相対パスを含めることはできません。contentType
- このResource
インスタンスがResource.getContentType()
から返す MIME コンテンツ。値がnull
の場合、リソースのコンテンツ型は resourceName をExternalContext.getMimeType(java.lang.String)
に渡すことによって導出されます。- 戻り値:
- 新しく作成された
Resource
インスタンス。指定されたリソースのエンコードまたはデコードでの使用に適しています。
handleResourceRequest
public void handleResourceRequest(FacesContext context) throws IOExceptionSE
このメソッドのデフォルトの動作は、ラップされた
ResourceHandler
オブジェクトでResourceHandler.handleResourceRequest(jakarta.faces.context.FacesContext)
を呼び出すことです。- 次で指定:
- クラス
ResourceHandler
のhandleResourceRequest
- パラメーター:
context
- このリクエストのFacesContext
- 例外:
IOExceptionSE
- I/O エラーが発生したとき。
isResourceRequest
public boolean isResourceRequest(FacesContext context)
このメソッドのデフォルトの動作は、ラップされた
ResourceHandler
オブジェクトでResourceHandler.isResourceRequest(jakarta.faces.context.FacesContext)
を呼び出すことです。- 次で指定:
- クラス
ResourceHandler
のisResourceRequest
- パラメーター:
context
- このリクエストのFacesContext
- 戻り値:
- 現在のリクエストがリソースリクエストの場合は
true
、それ以外の場合はfalse
。
isResourceURL
public boolean isResourceURL(StringSE url)
このメソッドのデフォルトの動作は、ラップされた
ResourceHandler
オブジェクトでResourceHandler.isResourceURL(java.lang.String)
を呼び出すことです。- オーバーライド:
- クラス
ResourceHandler
のisResourceURL
- パラメーター:
url
-ResourceHandler.RESOURCE_IDENTIFIER
の存在をインスペクションする URL。- 戻り値:
- これがリソース URL の場合は
true
、それ以外の場合はfalse
。
libraryExists
public boolean libraryExists(StringSE libraryName)
このメソッドのデフォルトの動作は、ラップされた
ResourceHandler
オブジェクトでResourceHandler.libraryExists(String)
を呼び出すことです。- 次で指定:
- クラス
ResourceHandler
のlibraryExists
- パラメーター:
libraryName
- ライブラリ名。- 戻り値:
- ライブラリが存在する場合は
true
、それ以外の場合はfalse
。
getRendererTypeForResourceName
public StringSE getRendererTypeForResourceName(StringSE resourceName)
このメソッドのデフォルトの動作は、ラップされた
ResourceHandler
オブジェクトでResourceHandler.getRendererTypeForResourceName(String)
を呼び出すことです。- 次で指定:
- クラス
ResourceHandler
のgetRendererTypeForResourceName
- パラメーター:
resourceName
- リソース名。- 戻り値:
- レンダラーの型。
markResourceRendered
public void markResourceRendered(FacesContext context, StringSE resourceName, StringSE libraryName)
このメソッドのデフォルトの動作は、ラップされた
ResourceHandler
オブジェクトでResourceHandler.markResourceRendered(FacesContext, String, String)
を呼び出すことです。- オーバーライド:
- クラス
ResourceHandler
のmarkResourceRendered
- パラメーター:
context
- このリクエストのFacesContext
。resourceName
- リソースの名前。libraryName
- リソースが存在するライブラリの名前は、null
の場合があります。- 導入:
- 2.3
isResourceRendered
public boolean isResourceRendered(FacesContext context, StringSE resourceName, StringSE libraryName)
このメソッドのデフォルトの動作は、ラップされた
ResourceHandler
オブジェクトでResourceHandler.isResourceRendered(FacesContext, String, String)
を呼び出すことです。- オーバーライド:
- クラス
ResourceHandler
のisResourceRendered
- パラメーター:
context
- このリクエストのFacesContext
。resourceName
- リソースの名前。libraryName
- このリソースが存在するライブラリの名前は、null
の場合があります。- 戻り値:
- 指定されたリソースとライブラリ名で識別されるリソースがレンダリングされているかどうか。
- 導入:
- 2.3