com.sun.faces.facelets

Class PrivateApiFaceletCacheAdapter<V>

java.lang.Object

jakarta.faces.view.facelets.FaceletCache<V>

com.sun.faces.facelets.PrivateApiFaceletCacheAdapter<V>

public class PrivateApiFaceletCacheAdapter<V>
extends jakarta.faces.view.facelets.FaceletCache<V>

Nested Class Summary

Nested classes/interfaces inherited from class jakarta.faces.view.facelets.FaceletCache

jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>

Constructor Summary

Constructors

Constructor and Description
PrivateApiFaceletCacheAdapter(FaceletCache<V> privateApi)

Method Summary

Modifier and Type	Method and Description
V	getFacelet(URL url) Returns a cached Facelet instance.
jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>	getMemberFactory() Returns the FaceletCache.MemberFactory passed to FaceletCache.setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>) for the purpose of creating Facelet instance.
jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>	getMetadataMemberFactory() Returns the FaceletCache.MemberFactory passed to FaceletCache.setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>) for the purpose of creating View Metadata Facelet instance.
V	getViewMetadataFacelet(URL url) Returns a cached View Metadata Facelet instance.
boolean	isFaceletCached(URL url) Determines whether a cached Facelet instance exists for this URL.
boolean	isViewMetadataFaceletCached(URL url) Determines whether a cached View Metadata Facelet instance exists for this URL.
void	setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V> faceletFactory, jakarta.faces.view.facelets.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.

Methods inherited from class jakarta.faces.view.facelets.FaceletCache

setCacheFactories

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PrivateApiFaceletCacheAdapter

public PrivateApiFaceletCacheAdapter(FaceletCache<V> privateApi)

Method Detail

getFacelet

public V getFacelet(URL url)
             throws IOException

Description copied from class: jakarta.faces.view.facelets.FaceletCache

Returns a cached Facelet instance. If no instance is available, it will be created using the Facelet FaceletCache.MemberFactory and stored in the cache.

Specified by:

getFacelet in class jakarta.faces.view.facelets.FaceletCache<V>

Parameters:

url - URL for the Facelet being retrieved

Returns:

a cached or new Facelet

Throws:

IOException - if unable to load a file necessary to respond to service this method.

getViewMetadataFacelet

public V getViewMetadataFacelet(URL url)
                         throws IOException

Description copied from class: jakarta.faces.view.facelets.FaceletCache

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.

Specified by:

getViewMetadataFacelet in class jakarta.faces.view.facelets.FaceletCache<V>

Parameters:

url - URL for the View Metadata Facelet being retrieved

Returns:

a cached or new View Metadata Facelet instance

Throws:

IOException - if unable to load a file necessary to respond to service this method.

isFaceletCached

public boolean isFaceletCached(URL url)

Description copied from class: jakarta.faces.view.facelets.FaceletCache

Determines whether a cached Facelet instance exists for this URL. Returns true if a cached instance exists, false otherwise

Specified by:

isFaceletCached in class jakarta.faces.view.facelets.FaceletCache<V>

Parameters:

url - URL for the Facelet

Returns:

true if a cached instance exists, false otherwise

isViewMetadataFaceletCached

public boolean isViewMetadataFaceletCached(URL url)

Description copied from class: jakarta.faces.view.facelets.FaceletCache

Determines whether a cached View Metadata Facelet instance exists for this URL. Returns true if a cached instance exists, false otherwise

Specified by:

isViewMetadataFaceletCached in class jakarta.faces.view.facelets.FaceletCache<V>

Parameters:

url - URL for the View Metadata Facelet

Returns:

true if a cached instance exists, false otherwise

setMemberFactories

public void setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V> faceletFactory,
                               jakarta.faces.view.facelets.FaceletCache.MemberFactory<V> viewMetadataFaceletFactory)

Description copied from class: jakarta.faces.view.facelets.FaceletCache

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.

Overrides:

setMemberFactories in class jakarta.faces.view.facelets.FaceletCache<V>

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.

getMemberFactory

public jakarta.faces.view.facelets.FaceletCache.MemberFactory<V> getMemberFactory()

Description copied from class: jakarta.faces.view.facelets.FaceletCache

Returns the FaceletCache.MemberFactory passed to FaceletCache.setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>) for the purpose of creating Facelet instance.

Overrides:

getMemberFactory in class jakarta.faces.view.facelets.FaceletCache<V>

Returns:

the FaceletCache.MemberFactory passed to FaceletCache.setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>) for the purpose of creating Facelet instance.

getMetadataMemberFactory

public jakarta.faces.view.facelets.FaceletCache.MemberFactory<V> getMetadataMemberFactory()

Description copied from class: jakarta.faces.view.facelets.FaceletCache

Returns the FaceletCache.MemberFactory passed to FaceletCache.setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>) for the purpose of creating View Metadata Facelet instance.

Overrides:

getMetadataMemberFactory in class jakarta.faces.view.facelets.FaceletCache<V>

Returns:

the FaceletCache.MemberFactory passed to FaceletCache.setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>) for the purpose of creating View Metadata Facelet instance.