public abstract class ViewDeclarationLanguageFactory extends java.lang.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.
| Constructor and 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. |
| Modifier and Type | Method and Description |
|---|---|
java.util.List<ViewDeclarationLanguage> |
getAllViewDeclarationLanguages()
Gets the list of all view declaration languages supported by this runtime.
|
abstract ViewDeclarationLanguage |
getViewDeclarationLanguage(java.lang.String viewId)
Return the |
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. |
@Deprecated public 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.
wrapped - The implementation being wrapped.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.
getWrapped in interface FacesWrapper<ViewDeclarationLanguageFactory>public abstract ViewDeclarationLanguage getViewDeclarationLanguage(java.lang.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.
viewId - the viewId to be inspected for an appropriate ViewDeclarationLanguage implementation for
the VDL used in the view.ViewDeclarationLanguage corresponding to the argument viewIdjava.lang.NullPointerException - if viewId is null.public java.util.List<ViewDeclarationLanguage> getAllViewDeclarationLanguages()