- java.lang.Object
-
- javax.faces.view.facelets.FaceletCache<V>
-
public abstract class FaceletCache<V> extends Object
This API defines the facility by which the Facelets
ViewDeclarationLanguagecreates and caches instances of Facelets.The cache handles two different kinds of Facelets: View Facelets and View Metadata Facelets. The former is the usual Facelet that provides for the construction of a
UIComponenttree. This kind of Facelet is accessed via thegetFacelet(java.net.URL)andisFaceletCached(java.net.URL)methods. The latter is a special kind of Facelet that corresponds toViewDeclarationLanguage.getViewMetadata(javax.faces.context.FacesContext, java.lang.String). This kind of Facelet is accessed via thegetViewMetadataFacelet(java.net.URL)andisViewMetadataFaceletCached(java.net.URL)methods.- Since:
- 2.1
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static interfaceFaceletCache.MemberFactory<V>Factory interface for creating Facelet or View Metadata Facelet instances.
-
Constructor Summary
Constructors Constructor and Description FaceletCache()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method and Description abstract VgetFacelet(URL url)Returns a cached Facelet instance.
protected FaceletCache.MemberFactory<V>getMemberFactory()Returns the
FaceletCache.MemberFactorypassed tosetMemberFactories(javax.faces.view.facelets.FaceletCache.MemberFactory<V>, javax.faces.view.facelets.FaceletCache.MemberFactory<V>)for the purpose of creating Facelet instance.protected FaceletCache.MemberFactory<V>getMetadataMemberFactory()Returns the
FaceletCache.MemberFactorypassed tosetMemberFactories(javax.faces.view.facelets.FaceletCache.MemberFactory<V>, javax.faces.view.facelets.FaceletCache.MemberFactory<V>)for the purpose of creating View Metadata Facelet instance.abstract VgetViewMetadataFacelet(URL url)Returns a cached View Metadata Facelet instance.
abstract booleanisFaceletCached(URL url)Determines whether a cached Facelet instance exists for this URL.
abstract booleanisViewMetadataFaceletCached(URL url)Determines whether a cached View Metadata Facelet instance exists for this URL.
protected voidsetMemberFactories(FaceletCache.MemberFactory<V> faceletFactory, FaceletCache.MemberFactory<V> viewMetadataFaceletFactory)This must be called by the runtime at startup time, before any requests are serviced, and allows for the
FaceletCacheimplementation to provide theFaceletCache.MemberFactoryinstances that will be used to create instances of Facelets and View Metadata Facelets.
-
-
-
Method Detail
-
getFacelet
public abstract V getFacelet(URL url) throws IOException
Returns a cached Facelet instance. If no instance is available, it will be created using the Facelet
FaceletCache.MemberFactoryand stored in the cache.- Parameters:
url-URLfor the Facelet being retrieved- Throws:
NullPointerException- if argumenturlisnull.IOException
-
isFaceletCached
public abstract boolean isFaceletCached(URL url)
Determines whether a cached Facelet instance exists for this URL. Returns true if a cached instance exists, false otherwise
- Parameters:
url-URLfor the Facelet- Throws:
NullPointerException- if argumenturlisnull.
-
getViewMetadataFacelet
public abstract V getViewMetadataFacelet(URL url) throws IOException
Returns a cached View Metadata Facelet instance. If no instance is available, it will be created using the View Metadata Facelet
FaceletCache.MemberFactoryand stored in the cache.- Parameters:
url-URLfor the View Metadata Facelet being retrieved- Throws:
NullPointerException- if argumenturlisnull.IOException
-
isViewMetadataFaceletCached
public abstract boolean isViewMetadataFaceletCached(URL url)
Determines whether a cached View Metadata Facelet instance exists for this URL. Returns true if a cached instance exists, false otherwise
- Parameters:
url-URLfor the View Metadata Facelet- Throws:
NullPointerException- if argumenturlisnull.
-
setMemberFactories
protected void setMemberFactories(FaceletCache.MemberFactory<V> faceletFactory, FaceletCache.MemberFactory<V> viewMetadataFaceletFactory)
This must be called by the runtime at startup time, before any requests are serviced, and allows for the
FaceletCacheimplementation to provide theFaceletCache.MemberFactoryinstances that will be used to create instances of Facelets and View Metadata Facelets.- Parameters:
faceletFactory- theFaceletCache.MemberFactoryinstance that will be used to create instances of Facelets.viewMetadataFaceletFactory- theFaceletCache.MemberFactoryinstance that will be used to create instances of metadata Facelets.- Throws:
NullPointerException- if either argument isnull
-
getMemberFactory
protected FaceletCache.MemberFactory<V> getMemberFactory()
Returns the
FaceletCache.MemberFactorypassed tosetMemberFactories(javax.faces.view.facelets.FaceletCache.MemberFactory<V>, javax.faces.view.facelets.FaceletCache.MemberFactory<V>)for the purpose of creating Facelet instance.
-
getMetadataMemberFactory
protected FaceletCache.MemberFactory<V> getMetadataMemberFactory()
Returns the
FaceletCache.MemberFactorypassed tosetMemberFactories(javax.faces.view.facelets.FaceletCache.MemberFactory<V>, javax.faces.view.facelets.FaceletCache.MemberFactory<V>)for the purpose of creating View Metadata Facelet instance.
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/faces/view/facelets/faceletcache.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.