FaceletCache

java.lang.Object
- jakarta.faces.view.facelets.FaceletCache<V>

```
public abstract class FaceletCache<V>
extends java.lang.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 the getFacelet(java.net.URL) and isFaceletCached(java.net.URL) methods. The latter is a special kind of Facelet that corresponds to ViewDeclarationLanguage.getViewMetadata(jakarta.faces.context.FacesContext, java.lang.String). This kind of Facelet is accessed via the getViewMetadataFacelet(java.net.URL) and isViewMetadataFaceletCached(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.

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()

Constructors
Constructor and Description
`FaceletCache()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract V`	`getFacelet(java.net.URL url)` Returns a cached Facelet instance.
`protected FaceletCache.MemberFactory<V>`	`getMemberFactory()` Returns the `FaceletCache.MemberFactory` passed to `setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>)` for the purpose of creating Facelet instance.
`protected FaceletCache.MemberFactory<V>`	`getMetadataMemberFactory()` Returns the `FaceletCache.MemberFactory` passed to `setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>)` for the purpose of creating View Metadata Facelet instance.
`abstract V`	`getViewMetadataFacelet(java.net.URL url)` Returns a cached View Metadata Facelet instance.
`abstract boolean`	`isFaceletCached(java.net.URL url)` Determines whether a cached Facelet instance exists for this URL.
`abstract boolean`	`isViewMetadataFaceletCached(java.net.URL url)` Determines whether a cached View Metadata Facelet instance exists for this URL.
`void`	`setCacheFactories(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 the `FaceletCache.MemberFactory` instances that will be used to create instances of Facelets and View Metadata Facelets.
`protected void`	`setMemberFactories(FaceletCache.MemberFactory<V> faceletFactory, FaceletCache.MemberFactory<V> viewMetadataFaceletFactory)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FaceletCache
```
public FaceletCache()
```
- Method Detail
  - getFacelet
```
public abstract V getFacelet(java.net.URL url)
                      throws java.io.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
    
    Returns:
    
    a cached or new Facelet
    
    Throws:
    
    java.lang.NullPointerException - if argument url is null.
    
    java.io.IOException - if unable to load a file necessary to respond to service this method.
  - isFaceletCached
```
public abstract boolean isFaceletCached(java.net.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
    
    Returns:
    
    true if a cached instance exists, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - if argument url is null.
  - getViewMetadataFacelet
```
public abstract V getViewMetadataFacelet(java.net.URL url)
                                  throws java.io.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
    
    Returns:
    
    a cached or new View Metadata Facelet instance
    
    Throws:
    
    java.lang.NullPointerException - if argument url is null.
    
    java.io.IOException - if unable to load a file necessary to respond to service this method.
  - isViewMetadataFaceletCached
```
public abstract boolean isViewMetadataFaceletCached(java.net.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
    
    Returns:
    
    true if a cached instance exists, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - if argument url is null.
  - setCacheFactories
```
public void setCacheFactories(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 the FaceletCache.MemberFactory instances that will be used to create instances of Facelets and View Metadata Facelets. The default implementation calls through to setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory, jakarta.faces.view.facelets.FaceletCache.MemberFactory).
    
    Parameters:
    
    faceletFactory - the FaceletCache.MemberFactory instance that will be used to create instances of Facelets.
    
    viewMetadataFaceletFactory - the FaceletCache.MemberFactory instance that will be used to create instances of metadata Facelets.
    
    Throws:
    
    java.lang.NullPointerException - if either argument is null
    
    Since:
    
    2.3
  - setMemberFactories
```
@Deprecated
protected void setMemberFactories(FaceletCache.MemberFactory<V> faceletFactory,
                                              FaceletCache.MemberFactory<V> viewMetadataFaceletFactory)
```
    Deprecated.
    
    This must be called by the runtime at startup time, before any requests are serviced, and allows for the FaceletCache implementation to provide the FaceletCache.MemberFactory instances that will be used to create instances of Facelets and View Metadata Facelets.
    
    Parameters:
    
    faceletFactory - the FaceletCache.MemberFactory instance that will be used to create instances of Facelets.
    
    viewMetadataFaceletFactory - the FaceletCache.MemberFactory instance that will be used to create instances of metadata Facelets.
    
    Throws:
    
    java.lang.NullPointerException - if either argument is null
  - getMemberFactory
```
protected FaceletCache.MemberFactory<V> getMemberFactory()
```
    Returns the FaceletCache.MemberFactory passed to setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>) for the purpose of creating Facelet instance.
    
    Returns:
    
    the FaceletCache.MemberFactory passed to setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>) for the purpose of creating Facelet instance.
  - getMetadataMemberFactory
```
protected FaceletCache.MemberFactory<V> getMetadataMemberFactory()
```
    Returns the FaceletCache.MemberFactory passed to setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>) for the purpose of creating View Metadata Facelet instance.
    
    Returns:
    
    the FaceletCache.MemberFactory passed to setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>) for the purpose of creating View Metadata Facelet instance.

Class FaceletCache<V>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FaceletCache

Method Detail

getFacelet

isFaceletCached

getViewMetadataFacelet

isViewMetadataFaceletCached

setCacheFactories

setMemberFactories

getMemberFactory

getMetadataMemberFactory