- 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
ViewDeclarationLanguage
creates 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
UIComponent
tree. 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 interface
FaceletCache.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 V
getFacelet(URL url)
Returns a cached Facelet instance.
protected FaceletCache.MemberFactory<V>
getMemberFactory()
Returns the
FaceletCache.MemberFactory
passed 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.MemberFactory
passed 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 V
getViewMetadataFacelet(URL url)
Returns a cached View Metadata Facelet instance.
abstract boolean
isFaceletCached(URL url)
Determines whether a cached Facelet instance exists for this URL.
abstract boolean
isViewMetadataFaceletCached(URL url)
Determines whether a cached View Metadata Facelet instance exists for this URL.
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
FaceletCache
implementation to provide theFaceletCache.MemberFactory
instances 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.MemberFactory
and stored in the cache.- Parameters:
url
-URL
for the Facelet being retrieved- Throws:
NullPointerException
- if argumenturl
isnull
.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
-URL
for the Facelet- Throws:
NullPointerException
- if argumenturl
isnull
.
-
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.MemberFactory
and stored in the cache.- Parameters:
url
-URL
for the View Metadata Facelet being retrieved- Throws:
NullPointerException
- if argumenturl
isnull
.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
-URL
for the View Metadata Facelet- Throws:
NullPointerException
- if argumenturl
isnull
.
-
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
FaceletCache
implementation to provide theFaceletCache.MemberFactory
instances that will be used to create instances of Facelets and View Metadata Facelets.- Parameters:
faceletFactory
- theFaceletCache.MemberFactory
instance that will be used to create instances of Facelets.viewMetadataFaceletFactory
- theFaceletCache.MemberFactory
instance 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.MemberFactory
passed 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.MemberFactory
passed tosetMemberFactories(javax.faces.view.facelets.FaceletCache.MemberFactory<V>, javax.faces.view.facelets.FaceletCache.MemberFactory<V>)
for the purpose of creating View Metadata Facelet instance.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
07/10/2025 08:23:26 Cette version de la page est en cache (à la date du 07/10/2025 08:23:26) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 11/06/2005, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/faces/view/facelets/faceletcache.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.