Modifier and Type	Class and Description
public static interface	FaceletCache.MemberFactory<V> Factory interface for creating Facelet or View Metadata Facelet instances.

Modifier and Type	Field and Description
private FaceletCache.MemberFactory<V>	memberFactory
private FaceletCache.MemberFactory<V>	viewMetadataMemberFactory

Access	Constructor and Description
public	FaceletCache()

Method Summary

Modifier and Type	Method and Description
public abstract V	Returns: a cached or new `Facelet` getFacelet(URL `URL` for the Facelet being retrieved url) Returns a cached Facelet instance.
protected FaceletCache.MemberFactory<V>	Returns: the `MemberFactory` passed to `setCacheFactories` for the purpose of creating Facelet instance. getMemberFactory() Returns the `MemberFactory` passed to `setCacheFactories` for the purpose of creating Facelet instance.
protected FaceletCache.MemberFactory<V>	Returns: the `MemberFactory` passed to `setCacheFactories` for the purpose of creating View Metadata Facelet instance. getMetadataMemberFactory() Returns the `MemberFactory` passed to `setCacheFactories` for the purpose of creating View Metadata Facelet instance.
public abstract V	Returns: a cached or new View Metadata `Facelet` instance getViewMetadataFacelet(URL `URL` for the View Metadata Facelet being retrieved url) Returns a cached View Metadata Facelet instance.
public abstract boolean	Returns: true if a cached instance exists, false otherwise isFaceletCached(URL `URL` for the Facelet url) Determines whether a cached Facelet instance exists for this URL.
public abstract boolean	Returns: true if a cached instance exists, false otherwise isViewMetadataFaceletCached(URL `URL` for the View Metadata Facelet url) Determines whether a cached View Metadata Facelet instance exists for this URL.
public void	setCacheFactories(FaceletCache.MemberFactory<V> the `MemberFactory` instance that will be used to create instances of Facelets. faceletFactory, FaceletCache.MemberFactory<V> the `MemberFactory` instance that will be used to create instances of metadata Facelets. 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 `MemberFactory` instances that will be used to create instances of Facelets and View Metadata Facelets.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

memberFactory	back to summary
private FaceletCache.MemberFactory<V> memberFactory

viewMetadataMemberFactory	back to summary
private FaceletCache.MemberFactory<V> viewMetadataMemberFactory

Constructor Detail

FaceletCache	back to summary
public FaceletCache()

Method Detail

getFacelet back to summary

getFacelet	back to summary
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 `MemberFactory` and stored in the cache. Parameters url:URL `URL` for the Facelet being retrieved Returns:V a cached or new `Facelet` Exceptions IOException: if unable to load a file necessary to respond to service this method. NullPointerException: if argument `url` is `null`.

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 MemberFactory and stored in the cache.

Parameters

url:URL: URL for the Facelet being retrieved

Returns:V

a cached or new Facelet

Exceptions

IOException:: if unable to load a file necessary to respond to service this method.
NullPointerException:: if argument url is null.

getMemberFactory back to summary

getMemberFactory	back to summary
protected FaceletCache.MemberFactory<V> getMemberFactory() Returns the `MemberFactory` passed to `setCacheFactories` for the purpose of creating Facelet instance. Returns:FaceletCache.MemberFactory<V> the `MemberFactory` passed to `setCacheFactories` for the purpose of creating Facelet instance.

protected FaceletCache.MemberFactory<V> getMemberFactory()

Returns the MemberFactory passed to setCacheFactories for the purpose of creating Facelet instance.

Returns:FaceletCache.MemberFactory<V>: the MemberFactory passed to setCacheFactories for the purpose of creating Facelet instance.

getMetadataMemberFactory back to summary

protected FaceletCache.MemberFactory<V> getMetadataMemberFactory()

Returns the MemberFactory passed to setCacheFactories for the purpose of creating View Metadata Facelet instance.

Returns:FaceletCache.MemberFactory<V>: the MemberFactory passed to setCacheFactories for the purpose of creating View Metadata Facelet instance.

getViewMetadataFacelet back to summary

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 MemberFactory and stored in the cache.

Parameters

url:URL: URL for the View Metadata Facelet being retrieved

Returns:V

a cached or new View Metadata Facelet instance

Exceptions

IOException:: if unable to load a file necessary to respond to service this method.
NullPointerException:: if argument url is null.

isFaceletCached back to summary

isFaceletCached	back to summary
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 `URL` for the Facelet Returns:boolean true if a cached instance exists, false otherwise Exceptions NullPointerException: if argument `url` is `null`.

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: URL for the Facelet

Returns:boolean

true if a cached instance exists, false otherwise

Exceptions

NullPointerException:: if argument url is null.

isViewMetadataFaceletCached back to summary

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: URL for the View Metadata Facelet

Returns:boolean

true if a cached instance exists, false otherwise

Exceptions

NullPointerException:: if argument url is null.

setCacheFactories back to summary

setCacheFactories	back to summary
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 `MemberFactory` instances that will be used to create instances of Facelets and View Metadata Facelets. Parameters faceletFactory:FaceletCache.MemberFactory<V> the `MemberFactory` instance that will be used to create instances of Facelets. viewMetadataFaceletFactory:FaceletCache.MemberFactory<V> the `MemberFactory` instance that will be used to create instances of metadata Facelets. Exceptions NullPointerException: if either argument is `null` Since 2.3

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 MemberFactory instances that will be used to create instances of Facelets and View Metadata Facelets.

Parameters

faceletFactory:FaceletCache.MemberFactory<V>: the MemberFactory instance that will be used to create instances of Facelets.
viewMetadataFaceletFactory:FaceletCache.MemberFactory<V>: the MemberFactory instance that will be used to create instances of metadata Facelets.

Exceptions

NullPointerException:: if either argument is null

Since

2.3

jakarta.faces.view.facelets back to summary

public Interface FaceletCache.MemberFactory<V>

Factory interface for creating Facelet or View Metadata Facelet instances.

Method Summary

Modifier and Type	Method and Description
public V	Returns: the newly created `Facelet` or View Metadata `Facelet` newInstance(final URL the `URL` that will be used as the key for the instance being created. key) Create a Facelet or View Metadata Facelet (depending on the type of factory this is) for the argument URL.

Method Detail

newInstance back to summary

newInstance	back to summary
public V newInstance(final URL key) throws IOException Create a Facelet or View Metadata Facelet (depending on the type of factory this is) for the argument URL. Parameters key:URL the `URL` that will be used as the key for the instance being created. Returns:V the newly created `Facelet` or View Metadata `Facelet` Exceptions IOException: if unable to load a file necessary to respond to service this method. NullPointerException: if argument `key` is `null`.

public V newInstance(final URL key) throws IOException

Create a Facelet or View Metadata Facelet (depending on the type of factory this is) for the argument URL.

Parameters

key:URL: the URL that will be used as the key for the instance being created.

Returns:V

the newly created Facelet or View Metadata Facelet

Exceptions

IOException:: if unable to load a file necessary to respond to service this method.
NullPointerException:: if argument key is null.

public abstract Class FaceletCache<V>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface FaceletCache.MemberFactory<V>

Method Summary

Method Detail