Top Fields Constructors Methods
com.sun.faces.facelets

public Class PrivateApiFaceletCacheAdapter<V>

extends FaceletCache<V>
Class Inheritance
Imports
com.sun.faces.facelets.FaceletCache.InstanceFactory, java.io.IOException, java.net.URL, javax.faces.view.facelets.FaceletCache, .FaceletCache.MemberFactory

Field Summary

Modifier and TypeField and Description
private FaceletCache.MemberFactory<V>
private FaceletCache.MemberFactory<V>
private FaceletCache<V>
privateApi

Deprecated as a consequence of FaceletCache being deprecated.

Constructor Summary

AccessConstructor and Description
public
PrivateApiFaceletCacheAdapter(FaceletCache<V> privateApi)

Deprecated as a consequence of FaceletCache being deprecated.

Method Summary

Modifier and TypeMethod and Description
public V
getFacelet(URL
URL for the Facelet being retrieved
url
)

Implements abstract javax.faces.view.facelets.FaceletCache.getFacelet.

Returns a cached Facelet instance.

public FaceletCache.MemberFactory<V>
getMemberFactory()

Overrides javax.faces.view.facelets.FaceletCache.getMemberFactory.

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

public FaceletCache.MemberFactory<V>
getMetadataMemberFactory()

Overrides javax.faces.view.facelets.FaceletCache.getMetadataMemberFactory.

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

public V
getViewMetadataFacelet(URL
URL for the View Metadata Facelet being retrieved
url
)

Implements abstract javax.faces.view.facelets.FaceletCache.getViewMetadataFacelet.

Returns a cached View Metadata Facelet instance.

public boolean
isFaceletCached(URL
URL for the Facelet
url
)

Implements abstract javax.faces.view.facelets.FaceletCache.isFaceletCached.

Determines whether a cached Facelet instance exists for this URL.

public boolean
isViewMetadataFaceletCached(URL
URL for the View Metadata Facelet
url
)

Implements abstract javax.faces.view.facelets.FaceletCache.isViewMetadataFaceletCached.

Determines whether a cached View Metadata Facelet instance exists for this URL.

public void
setMemberFactories(final FaceletCache.MemberFactory<V>
the MemberFactory instance that will be used to create instances of Facelets.
faceletFactory
,
final FaceletCache.MemberFactory<V>
the MemberFactory instance that will be used to create instances of metadata Facelets.
viewMetadataFaceletFactory
)

Overrides javax.faces.view.facelets.FaceletCache.setMemberFactories.

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 javax.faces.view.facelets.FaceletCache:
setCacheFactories

Field Detail

memberFactoryback to summary
private FaceletCache.MemberFactory<V> memberFactory

Hides javax.faces.view.facelets.FaceletCache.memberFactory.

metadataMemberFactoryback to summary
private FaceletCache.MemberFactory<V> metadataMemberFactory
privateApiback to summary
private FaceletCache<V> privateApi

Deprecated

as a consequence of FaceletCache being deprecated. See corresponding docs for further information.

Constructor Detail

PrivateApiFaceletCacheAdapterback to summary
public PrivateApiFaceletCacheAdapter(FaceletCache<V> privateApi)

Deprecated

as a consequence of FaceletCache being deprecated. See corresponding docs for further information.

Method Detail

getFaceletback to summary
public V getFacelet(URL url) throws IOException

Implements abstract javax.faces.view.facelets.FaceletCache.getFacelet.

Doc from javax.faces.view.facelets.FaceletCache.getFacelet.

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

Annotations
@Override
Exceptions
IOException:
if unable to load a file necessary to respond to service this method.
getMemberFactoryback to summary
public FaceletCache.MemberFactory<V> getMemberFactory()

Overrides javax.faces.view.facelets.FaceletCache.getMemberFactory.

Doc from javax.faces.view.facelets.FaceletCache.getMemberFactory.

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

Returns:FaceletCache.MemberFactory<V>

the MemberFactory passed to setMemberFactories for the purpose of creating Facelet instance.

Annotations
@Override
getMetadataMemberFactoryback to summary
public FaceletCache.MemberFactory<V> getMetadataMemberFactory()

Overrides javax.faces.view.facelets.FaceletCache.getMetadataMemberFactory.

Doc from javax.faces.view.facelets.FaceletCache.getMetadataMemberFactory.

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

Returns:FaceletCache.MemberFactory<V>

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

Annotations
@Override
getViewMetadataFaceletback to summary
public V getViewMetadataFacelet(URL url) throws IOException

Implements abstract javax.faces.view.facelets.FaceletCache.getViewMetadataFacelet.

Doc from javax.faces.view.facelets.FaceletCache.getViewMetadataFacelet.

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

Annotations
@Override
Exceptions
IOException:
if unable to load a file necessary to respond to service this method.
isFaceletCachedback to summary
public boolean isFaceletCached(URL url)

Implements abstract javax.faces.view.facelets.FaceletCache.isFaceletCached.

Doc from javax.faces.view.facelets.FaceletCache.isFaceletCached.

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

Annotations
@Override
isViewMetadataFaceletCachedback to summary
public boolean isViewMetadataFaceletCached(URL url)

Implements abstract javax.faces.view.facelets.FaceletCache.isViewMetadataFaceletCached.

Doc from javax.faces.view.facelets.FaceletCache.isViewMetadataFaceletCached.

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

Annotations
@Override
setMemberFactoriesback to summary
public void setMemberFactories(final FaceletCache.MemberFactory<V> faceletFactory, final FaceletCache.MemberFactory<V> viewMetadataFaceletFactory)

Overrides javax.faces.view.facelets.FaceletCache.setMemberFactories.

Doc from javax.faces.view.facelets.FaceletCache.setMemberFactories.

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.

Annotations
@Override