Modifier and Type	Class and Description
private static class	DefaultFacelet.ApplyToken

Modifier and Type	Field and Description
private final String	alias
private static final String	APPLIED_KEY
private final long	createTime
private final ExpressionFactory	elFactory
private final DefaultFaceletFactory	factory
private static final String	JAKARTA_FACES_ERROR_XHTML
private static final Logger	log
private IdMapper	mapper
private final long	refreshPeriod
private final FaceletHandler	root
private Doctype	savedDoctype
private String	savedXMLDecl
private final URL	src

Access	Constructor and Description
public	DefaultFacelet(DefaultFaceletFactory factory, ExpressionFactory el, URL src, String alias, FaceletHandler root)

Method Summary

Modifier and Type	Method and Description
public void	apply(FacesContext The current FacesContext (Should be the same as FacesContext.getInstance()) facesContext, UIComponent The UIComponent to populate in a compositional fashion. In most cases a Facelet will be base a UIViewRoot. parent) Implements abstract jakarta.faces.view.facelets.Facelet.apply. The passed UIComponent parent will be populated/restored in accordance with the section 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" in the Jakarta Faces Specification Document.
public void	applyMetadata(FacesContext The current FacesContext (Should be the same as FacesContext.getInstance()) facesContext, UIComponent The UIComponent to populate in a compositional fashion. In most cases a Facelet will be base a UIViewRoot. parent) Overrides jakarta.faces.view.facelets.Facelet.applyMetadata. The passed UIComponent parent will be populated/restored in accordance with the section 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" in the Jakarta Faces Specification Document with only the meta data as per the `f:metadata` tag.
public String	Returns: alias name getAlias() Return the alias name for error messages and logging
public long	Returns: final timestamp of when this Facelet was created getCreateTime() The time when this Facelet was created, NOT the URL source code
private URL	getErrorFacelet(ClassLoader loader)
public ExpressionFactory	Returns: internal ExpressionFactory instance getExpressionFactory() Return this Facelet's ExpressionFactory instance
public Doctype	getSavedDoctype() Implements com.sun.faces.facelets.impl.XMLFrontMatterSaver.getSavedDoctype.
public String	getSavedXMLDecl() Implements com.sun.faces.facelets.impl.XMLFrontMatterSaver.getSavedXMLDecl.
public URL	Returns: the URL this Facelet was created from getSource() The URL this Facelet was created from.
private void	include(DefaultFaceletContext the FaceletContext to use for applying our FaceletHandlers ctx, UIComponent the parent component to apply changes to parent) Given the passed FaceletContext, apply our child FaceletHandlers to the passed parent
public void	include(DefaultFaceletContext FaceletContext to pass to the included Facelet ctx, UIComponent UIComponent to apply changes to parent, String relative path to the desired Facelet from the FaceletContext relativePath) Used for delegation by the DefaultFaceletContext.
public void	include(DefaultFaceletContext FaceletContext to pass to the included Facelet ctx, UIComponent UIComponent to apply changes to parent, URL URL source to include Facelet from url) Grabs a DefaultFacelet from referenced DefaultFaceletFacotry
private boolean	isDevelopment(FaceletContext ctx)
private void	markApplied(UIComponent parent)
private void	refresh(UIComponent c)
private URL	Returns: URL pointing to destination resolveURL(String a relative url path relativePath) Delegates resolution to DefaultFaceletFactory reference.
public void	setSavedDoctype(Doctype savedDoctype) Implements com.sun.faces.facelets.impl.XMLFrontMatterSaver.setSavedDoctype.
public void	setSavedXMLDecl(String savedXMLDecl) Implements com.sun.faces.facelets.impl.XMLFrontMatterSaver.setSavedXMLDecl.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Field Detail

alias	back to summary
private final String alias

APPLIED_KEY	back to summary
private static final String APPLIED_KEY

createTime	back to summary
private final long createTime

elFactory	back to summary
private final ExpressionFactory elFactory

factory	back to summary
private final DefaultFaceletFactory factory

JAKARTA_FACES_ERROR_XHTML	back to summary
private static final String JAKARTA_FACES_ERROR_XHTML

log	back to summary
private static final Logger log

mapper	back to summary
private IdMapper mapper

refreshPeriod	back to summary
private final long refreshPeriod

root	back to summary
private final FaceletHandler root

savedDoctype	back to summary
private Doctype savedDoctype

savedXMLDecl	back to summary
private String savedXMLDecl

src	back to summary
private final URL src

Constructor Detail

DefaultFacelet	back to summary
public DefaultFacelet(DefaultFaceletFactory factory, ExpressionFactory el, URL src, String alias, FaceletHandler root)

Method Detail

apply back to summary

apply	back to summary
public void apply(FacesContext facesContext, UIComponent parent) throws IOException Implements abstract jakarta.faces.view.facelets.Facelet.apply. Doc from jakarta.faces.view.facelets.Facelet.apply. The passed UIComponent parent will be populated/restored in accordance with the section 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" in the Jakarta Faces Specification Document. Parameters facesContext:FacesContext The current FacesContext (Should be the same as FacesContext.getInstance()) parent:UIComponent The UIComponent to populate in a compositional fashion. In most cases a Facelet will be base a UIViewRoot. Annotations @Override Exceptions IOException: if unable to load a file necessary to apply this `Facelet` See Also `jakarta.faces.view.facelets.Facelet#apply(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)`

public void apply(FacesContext facesContext, UIComponent parent) throws IOException

Implements abstract jakarta.faces.view.facelets.Facelet.apply.

Doc from jakarta.faces.view.facelets.Facelet.apply.

The passed UIComponent parent will be populated/restored in accordance with the section 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" in the Jakarta Faces Specification Document.

Parameters

facesContext:FacesContext: The current FacesContext (Should be the same as FacesContext.getInstance())
parent:UIComponent: The UIComponent to populate in a compositional fashion. In most cases a Facelet will be base a UIViewRoot.

Annotations

@Override

Exceptions

IOException:: if unable to load a file necessary to apply this Facelet

applyMetadata back to summary

public void applyMetadata(FacesContext facesContext, UIComponent parent) throws IOException

Overrides jakarta.faces.view.facelets.Facelet.applyMetadata.

Doc from jakarta.faces.view.facelets.Facelet.applyMetadata.

Parameters

facesContext:FacesContext: The current FacesContext (Should be the same as FacesContext.getInstance())
parent:UIComponent: The UIComponent to populate in a compositional fashion. In most cases a Facelet will be base a UIViewRoot.

Annotations

@Override

Exceptions

IOException:: if unable to load a file necessary to apply this Facelet

getAlias	back to summary
public String getAlias() Return the alias name for error messages and logging Returns:String alias name

getAlias

back to summary

public String getAlias()

Return the alias name for error messages and logging

Returns:String: alias name

getCreateTime	back to summary
public long getCreateTime() The time when this Facelet was created, NOT the URL source code Returns:long final timestamp of when this Facelet was created

getCreateTime

back to summary

public long getCreateTime()

The time when this Facelet was created, NOT the URL source code

Returns:long: final timestamp of when this Facelet was created

getErrorFacelet	back to summary
private URL getErrorFacelet(ClassLoader loader)

getExpressionFactory	back to summary
public ExpressionFactory getExpressionFactory() Return this Facelet's ExpressionFactory instance Returns:ExpressionFactory internal ExpressionFactory instance

getExpressionFactory

back to summary

public ExpressionFactory getExpressionFactory()

Return this Facelet's ExpressionFactory instance

Returns:ExpressionFactory: internal ExpressionFactory instance

getSavedDoctype	back to summary
public Doctype getSavedDoctype() Implements com.sun.faces.facelets.impl.XMLFrontMatterSaver.getSavedDoctype. Annotations @Override

getSavedDoctype

back to summary

public Doctype getSavedDoctype()

Implements com.sun.faces.facelets.impl.XMLFrontMatterSaver.getSavedDoctype.

Annotations

@Override

getSavedXMLDecl	back to summary
public String getSavedXMLDecl() Implements com.sun.faces.facelets.impl.XMLFrontMatterSaver.getSavedXMLDecl. Annotations @Override

getSavedXMLDecl

back to summary

public String getSavedXMLDecl()

Implements com.sun.faces.facelets.impl.XMLFrontMatterSaver.getSavedXMLDecl.

Annotations

@Override

getSource	back to summary
public URL getSource() The URL this Facelet was created from. Returns:URL the URL this Facelet was created from

getSource

back to summary

public URL getSource()

The URL this Facelet was created from.

Returns:URL: the URL this Facelet was created from

include back to summary

include	back to summary
private void include(DefaultFaceletContext ctx, UIComponent parent) throws IOException Given the passed FaceletContext, apply our child FaceletHandlers to the passed parent Parameters ctx:DefaultFaceletContext the FaceletContext to use for applying our FaceletHandlers parent:UIComponent the parent component to apply changes to See Also `FaceletHandler#apply(FaceletContext, UIComponent)`

private void include(DefaultFaceletContext ctx, UIComponent parent) throws IOException

Given the passed FaceletContext, apply our child FaceletHandlers to the passed parent

Parameters

ctx:DefaultFaceletContext: the FaceletContext to use for applying our FaceletHandlers
parent:UIComponent: the parent component to apply changes to

include back to summary

include	back to summary
public void include(DefaultFaceletContext ctx, UIComponent parent, String relativePath) throws IOException Used for delegation by the DefaultFaceletContext. First validates that the path does not represent a contracts resource, then pulls the URL from `resolveURL(String)`, then calls `include(DefaultFaceletContext, jakarta.faces.component.UIComponent, String)`. Parameters ctx:DefaultFaceletContext FaceletContext to pass to the included Facelet parent:UIComponent UIComponent to apply changes to relativePath:String relative path to the desired Facelet from the FaceletContext See Also `FaceletContext#includeFacelet(UIComponent, String)`

public void include(DefaultFaceletContext ctx, UIComponent parent, String relativePath) throws IOException

Used for delegation by the DefaultFaceletContext. First validates that the path does not represent a contracts resource, then pulls the URL from resolveURL(String), then calls include(DefaultFaceletContext, jakarta.faces.component.UIComponent, String).

Parameters

ctx:DefaultFaceletContext: FaceletContext to pass to the included Facelet
parent:UIComponent: UIComponent to apply changes to
relativePath:String: relative path to the desired Facelet from the FaceletContext

include back to summary

include	back to summary
public void include(DefaultFaceletContext ctx, UIComponent parent, URL url) throws IOException Grabs a DefaultFacelet from referenced DefaultFaceletFacotry Parameters ctx:DefaultFaceletContext FaceletContext to pass to the included Facelet parent:UIComponent UIComponent to apply changes to url:URL URL source to include Facelet from See Also `DefaultFaceletFactory#getFacelet(FacesContext, URL)`

public void include(DefaultFaceletContext ctx, UIComponent parent, URL url) throws IOException

Grabs a DefaultFacelet from referenced DefaultFaceletFacotry

Parameters

ctx:DefaultFaceletContext: FaceletContext to pass to the included Facelet
parent:UIComponent: UIComponent to apply changes to
url:URL: URL source to include Facelet from

isDevelopment	back to summary
private boolean isDevelopment(FaceletContext ctx)

markApplied	back to summary
private void markApplied(UIComponent parent)

refresh	back to summary
private void refresh(UIComponent c)

resolveURL	back to summary
private URL resolveURL(String relativePath) throws IOException Delegates resolution to DefaultFaceletFactory reference. Also, caches URLs for absolute paths. Parameters relativePath:String a relative url path Returns:URL URL pointing to destination Exceptions IOException: if there is a problem creating the URL for the path specified

resolveURL

back to summary

private URL resolveURL(String relativePath) throws IOException

Delegates resolution to DefaultFaceletFactory reference. Also, caches URLs for absolute paths.

Parameters

relativePath:String: a relative url path

Returns:URL

URL pointing to destination

Exceptions

IOException:: if there is a problem creating the URL for the path specified

setSavedDoctype	back to summary
public void setSavedDoctype(Doctype savedDoctype) Implements com.sun.faces.facelets.impl.XMLFrontMatterSaver.setSavedDoctype. Annotations @Override

setSavedDoctype

back to summary

public void setSavedDoctype(Doctype savedDoctype)

Implements com.sun.faces.facelets.impl.XMLFrontMatterSaver.setSavedDoctype.

Annotations

@Override

setSavedXMLDecl	back to summary
public void setSavedXMLDecl(String savedXMLDecl) Implements com.sun.faces.facelets.impl.XMLFrontMatterSaver.setSavedXMLDecl. Annotations @Override

setSavedXMLDecl

back to summary

public void setSavedXMLDecl(String savedXMLDecl)

Implements com.sun.faces.facelets.impl.XMLFrontMatterSaver.setSavedXMLDecl.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

com.sun.faces.facelets.impl back to summary

private Class DefaultFacelet.ApplyToken

Class Inheritance

extends Object
implements Externalizable

java.lang.Object
com.sun.faces.facelets.impl.DefaultFacelet.ApplyToken

All Implemented Interfaces

java.io.Externalizable, java.io.Serializable

Field Summary

Modifier and Type	Field and Description
public String	alias
public long	time

Constructor Summary

Access	Constructor and Description
public	ApplyToken()
public	ApplyToken(String alias, long time)

Method Summary

Modifier and Type	Method and Description
public void	readExternal(ObjectInput the stream to read data from in order to restore the object in) Implements java.io.Externalizable.readExternal. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
public void	writeExternal(ObjectOutput the stream to write the object to out) Implements java.io.Externalizable.writeExternal. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

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

Field Detail

alias	back to summary
public String alias

time	back to summary
public long time

Constructor Detail

ApplyToken	back to summary
public ApplyToken() Annotations @SuppressWarnings:UnusedDeclaration

ApplyToken	back to summary
public ApplyToken(String alias, long time)

Method Detail

readExternal	back to summary
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException Implements java.io.Externalizable.readExternal. Doc from java.io.Externalizable.readExternal. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal. Parameters in:ObjectInput the stream to read data from in order to restore the object Annotations @Override Exceptions IOException: if I/O errors occur ClassNotFoundException: If the class for an object being restored cannot be found.

readExternal

back to summary

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Implements java.io.Externalizable.readExternal.

Doc from java.io.Externalizable.readExternal.

The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Parameters

in:ObjectInput: the stream to read data from in order to restore the object

Annotations

@Override

Exceptions

IOException:: if I/O errors occur
ClassNotFoundException:: If the class for an object being restored cannot be found.

writeExternal	back to summary
public void writeExternal(ObjectOutput out) throws IOException Implements java.io.Externalizable.writeExternal. Doc from java.io.Externalizable.writeExternal. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays. Parameters out:ObjectOutput the stream to write the object to Annotations @Override Exceptions IOException: Includes any I/O exceptions that may occur

writeExternal

back to summary

public void writeExternal(ObjectOutput out) throws IOException

Implements java.io.Externalizable.writeExternal.

Doc from java.io.Externalizable.writeExternal.

The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Parameters

out:ObjectOutput: the stream to write the object to

Annotations

@Override

Exceptions

IOException:: Includes any I/O exceptions that may occur

pack-priv final Class DefaultFacelet

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DefaultFacelet.ApplyToken

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail