Top Description Fields Constructors Methods
jakarta.faces.view

public abstract Class ViewDeclarationLanguageFactory

extends Object
implements FacesWrapper<ViewDeclarationLanguageFactory>
Class Inheritance
All Implemented Interfaces
jakarta.faces.FacesWrapper
Static Imports
java.util.Collections.emptyList

ViewDeclarationLanguageFactory is a factory object that creates (if needed) and returns a new ViewDeclarationLanguage instance based on the VDL found in a specific view.

There must be one ViewDeclarationLanguageFactory instance per web application that is utilizing Jakarta Server Faces. This instance can be acquired, in a portable manner, by calling: 


  ViewDeclarationLanguageFactory factory = (ViewDeclarationLanguageFactory)
   FactoryFinder.getFactory(FactoryFinder.VIEW_DECLARATION_LANGUAGE_FACTORY);

Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped to access the instance being wrapped.

Since
2.0

Field Summary

Modifier and TypeField and Description
private ViewDeclarationLanguageFactory
wrapped

Constructor Summary

AccessConstructor and Description
public
ViewDeclarationLanguageFactory()

Deprecated Use the other constructor taking the implementation being wrapped.
public
ViewDeclarationLanguageFactory(ViewDeclarationLanguageFactory
The implementation being wrapped.
wrapped)

If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

Method Summary

Modifier and TypeMethod and Description
public List<ViewDeclarationLanguage>

Returns:

the list of all view declaration languages supported by this runtime.
getAllViewDeclarationLanguages()

Gets the list of all view declaration languages supported by this runtime.

public abstract ViewDeclarationLanguage

Returns:

the ViewDeclarationLanguage corresponding to the argument viewId
getViewDeclarationLanguage(String
the viewId to be inspected for an appropriate ViewDeclarationLanguage implementation for the VDL used in the view.
viewId)

Return the ViewDeclarationLanguage instance suitable for handling the VDL contained in the page referenced by the argument viewId.

public ViewDeclarationLanguageFactory
getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

wrappedback to summary
private ViewDeclarationLanguageFactory wrapped

Constructor Detail

ViewDeclarationLanguageFactoryback to summary
public ViewDeclarationLanguageFactory()

Deprecated

Use the other constructor taking the implementation being wrapped.

Annotations
@Deprecated
ViewDeclarationLanguageFactoryback to summary
public ViewDeclarationLanguageFactory(ViewDeclarationLanguageFactory wrapped)

If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The getWrapped() will then return the implementation being wrapped.

Parameters
wrapped:ViewDeclarationLanguageFactory

The implementation being wrapped.

Method Detail

getAllViewDeclarationLanguagesback to summary
public List<ViewDeclarationLanguage> getAllViewDeclarationLanguages()

Gets the list of all view declaration languages supported by this runtime.

Returns:List<ViewDeclarationLanguage>

the list of all view declaration languages supported by this runtime.

getViewDeclarationLanguageback to summary
public abstract ViewDeclarationLanguage getViewDeclarationLanguage(String viewId)

Return the ViewDeclarationLanguage instance suitable for handling the VDL contained in the page referenced by the argument viewId. The default implementation must return a valid ViewDeclarationLanguage instance for views written in either Jakarta Server Pages, Faces XML Views, or Facelets for Jakarta Faces 2.

Parameters
viewId:String

the viewId to be inspected for an appropriate ViewDeclarationLanguage implementation for the VDL used in the view.

Returns:ViewDeclarationLanguage

the ViewDeclarationLanguage corresponding to the argument viewId

Exceptions
NullPointerException:
if viewId is null.
Since
2.0
getWrappedback to summary
public ViewDeclarationLanguageFactory getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.

Returns:ViewDeclarationLanguageFactory

Doc from jakarta.faces.FacesWrapper.getWrapped.

the wrapped instance.

Annotations
@Override