Module jakarta.faces

Package jakarta.faces.view

Class ViewDeclarationLanguageFactory

java.lang.Object

jakarta.faces.view.ViewDeclarationLanguageFactory

All Implemented Interfaces:

FacesWrapper<ViewDeclarationLanguageFactory>

Direct Known Subclasses:

ViewDeclarationLanguageFactoryImpl

public abstract class ViewDeclarationLanguageFactory
extends Object
implements FacesWrapper<ViewDeclarationLanguageFactory>

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

Constructor Summary

Constructors

Constructor	Description
ViewDeclarationLanguageFactory()	Deprecated. Use the other constructor taking the implementation being wrapped.
ViewDeclarationLanguageFactory(ViewDeclarationLanguageFactory 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 Type	Method	Description
List<ViewDeclarationLanguage>	getAllViewDeclarationLanguages()	Gets the list of all view declaration languages supported by this runtime.
abstract ViewDeclarationLanguage	getViewDeclarationLanguage(String viewId)	Return the ViewDeclarationLanguage instance suitable for handling the VDL contained in the page referenced by the argument viewId.
ViewDeclarationLanguageFactory	getWrapped()	If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.

Methods inherited from class java.lang.Object

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

Constructor Details

ViewDeclarationLanguageFactory

@Deprecated
public ViewDeclarationLanguageFactory()

Deprecated.

Use the other constructor taking the implementation being wrapped.

ViewDeclarationLanguageFactory

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 - The implementation being wrapped.

Method Details

getWrapped

public ViewDeclarationLanguageFactory getWrapped()

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

Specified by:

getWrapped in interface FacesWrapper<ViewDeclarationLanguageFactory>

Returns:

the wrapped instance.

getViewDeclarationLanguage

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 - the viewId to be inspected for an appropriate ViewDeclarationLanguage implementation for the VDL used in the view.

Returns:

the ViewDeclarationLanguage corresponding to the argument viewId

Throws:

NullPointerException - if viewId is null.

Since:

2.0

getAllViewDeclarationLanguages

public List<ViewDeclarationLanguage> getAllViewDeclarationLanguages()

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

Returns:

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