org.apache.myfaces.view.facelets.impl

Class DefaultFaceletFactory

java.lang.Object

org.apache.myfaces.view.facelets.FaceletFactory

org.apache.myfaces.view.facelets.impl.DefaultFaceletFactory

public final class DefaultFaceletFactory
extends FaceletFactory

Default FaceletFactory implementation.

Version:

$Id: DefaultFaceletFactory.java 1341411 2012-05-22 11:19:42Z lu4242 $

Author:

Jacob Hookom

Field Summary

Fields

Modifier and Type	Field and Description
protected Logger	log

Constructor Summary

Constructors

Constructor and Description
DefaultFaceletFactory(Compiler compiler, ResourceResolver resolver)
DefaultFaceletFactory(Compiler compiler, ResourceResolver resolver, long refreshPeriod)

Method Summary

Methods

Modifier and Type	Method and Description
Compiler	getCompiler() Compiler this factory uses
Facelet	getCompositeComponentMetadataFacelet(String uri) Works in the same way as getFacelet(String uri), but redirect to getViewMetadataFacelet(URL url)
Facelet	getCompositeComponentMetadataFacelet(URL url) Create a Facelet used to create composite component metadata from the passed URL.
Facelet	getFacelet(String uri) Return a Facelet instance as specified by the file at the passed URI.
Facelet	getFacelet(URL url) Create a Facelet from the passed URL.
long	getRefreshPeriod()
Facelet	getViewMetadataFacelet(String uri) Works in the same way as getFacelet(String uri), but redirect to getViewMetadataFacelet(URL url)
Facelet	getViewMetadataFacelet(URL url) Create a Facelet used to create view metadata from the passed URL.
protected boolean	needsToBeRefreshed(org.apache.myfaces.view.facelets.impl.DefaultFacelet facelet) Template method for determining if the Facelet needs to be refreshed.
URL	resolveURL(URL source, String path) Resolves a path based on the passed URL.

Methods inherited from class org.apache.myfaces.view.facelets.FaceletFactory

getInstance, setInstance

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final Logger log

Constructor Detail

DefaultFaceletFactory

public DefaultFaceletFactory(Compiler compiler,
                     ResourceResolver resolver)
                      throws IOException

Throws:

IOException

DefaultFaceletFactory

public DefaultFaceletFactory(Compiler compiler,
                     ResourceResolver resolver,
                     long refreshPeriod)

Method Detail

getCompiler

public Compiler getCompiler()

Compiler this factory uses

Returns:

final Compiler instance

getFacelet

public Facelet getFacelet(String uri)
                   throws IOException,
                          FaceletException,
                          FacesException,
                          javax.el.ELException

Description copied from class: FaceletFactory

Return a Facelet instance as specified by the file at the passed URI.

Specified by:

getFacelet in class FaceletFactory

Returns:

Throws:

IOException

FaceletException

FacesException

javax.el.ELException

getFacelet

public Facelet getFacelet(URL url)
                   throws IOException,
                          FaceletException,
                          FacesException,
                          javax.el.ELException

Create a Facelet from the passed URL. This method checks if the cached Facelet needs to be refreshed before returning. If so, uses the passed URL to build a new instance;

Specified by:

getFacelet in class FaceletFactory

Parameters:

url - source url

Returns:

Facelet instance

Throws:

IOException

FaceletException

FacesException

javax.el.ELException

getRefreshPeriod

public long getRefreshPeriod()

resolveURL

public URL resolveURL(URL source,
             String path)
               throws IOException

Resolves a path based on the passed URL. If the path starts with '/', then resolve the path against javax.faces.context.ExternalContext#getResource(java.lang.String). Otherwise create a new URL via URL(URL, String).

Parameters:

source - base to resolve from

path - relative path to the source

Returns:

resolved URL

Throws:

IOException

needsToBeRefreshed

protected boolean needsToBeRefreshed(org.apache.myfaces.view.facelets.impl.DefaultFacelet facelet)

Template method for determining if the Facelet needs to be refreshed.

Parameters:

facelet - Facelet that could have expired

Returns:

true if it needs to be refreshed

getViewMetadataFacelet

public Facelet getViewMetadataFacelet(String uri)
                               throws IOException

Works in the same way as getFacelet(String uri), but redirect to getViewMetadataFacelet(URL url)

Specified by:

getViewMetadataFacelet in class FaceletFactory

Returns:

Throws:

IOException

Since:

2.0

getViewMetadataFacelet

public Facelet getViewMetadataFacelet(URL url)
                               throws IOException,
                                      FaceletException,
                                      FacesException,
                                      javax.el.ELException

Description copied from class: FaceletFactory

Create a Facelet used to create view metadata from the passed URL. This method checks if the cached Facelet needs to be refreshed before returning. If so, uses the passed URL to build a new instance;

Specified by:

getViewMetadataFacelet in class FaceletFactory

Parameters:

url - source url

Returns:

Facelet instance

Throws:

IOException

FaceletException

FacesException

javax.el.ELException

Since:

2.0

getCompositeComponentMetadataFacelet

public Facelet getCompositeComponentMetadataFacelet(String uri)
                                             throws IOException

Works in the same way as getFacelet(String uri), but redirect to getViewMetadataFacelet(URL url)

Specified by:

getCompositeComponentMetadataFacelet in class FaceletFactory

Returns:

Throws:

IOException

Since:

2.0.1

getCompositeComponentMetadataFacelet

public Facelet getCompositeComponentMetadataFacelet(URL url)
                                             throws IOException,
                                                    FaceletException,
                                                    FacesException,
                                                    javax.el.ELException

Description copied from class: FaceletFactory

Create a Facelet used to create composite component metadata from the passed URL. This method checks if the cached Facelet needs to be refreshed before returning. If so, uses the passed URL to build a new instance.

Specified by:

getCompositeComponentMetadataFacelet in class FaceletFactory

Parameters:

url - source url

Returns:

Facelet instance

Throws:

IOException

FaceletException

FacesException

javax.el.ELException

Since:

2.0.1