org.apache.myfaces.shared.view
Class ViewDeclarationLanguageBase

java.lang.Object
  javax.faces.view.ViewDeclarationLanguage
      org.apache.myfaces.shared.view.ViewDeclarationLanguageBase

Direct Known Subclasses:

JspViewDeclarationLanguageBase

public abstract class ViewDeclarationLanguageBase
extends ViewDeclarationLanguage

Since:

2.0

Version:

$Revision: 1187701 $ $Date: 2011-10-22 07:21:54 -0500 (Sat, 22 Oct 2011) $

Author:

Simon Lessard (latest modification by $Author: bommel $)

Field Summary

Fields inherited from class javax.faces.view.ViewDeclarationLanguage

FACELETS_VIEW_DECLARATION_LANGUAGE_ID, JSP_VIEW_DECLARATION_LANGUAGE_ID

Constructor Summary

ViewDeclarationLanguageBase()

Method Summary

protected abstract String	calculateViewId(FacesContext context, String viewId) Calculates the effective view identifier for the specified raw view identifier.
protected void	checkNull(Object o, String param) Check if the specified value of a param is null.
UIViewRoot	createView(FacesContext context, String viewId) Process the specification required algorithm that is generic to all PDL.
UIViewRoot	restoreView(FacesContext context, String viewId)
protected abstract void	sendSourceNotFound(FacesContext context, String message) Send a source not found to the client.

Methods inherited from class javax.faces.view.ViewDeclarationLanguage

buildView, getComponentMetadata, getId, getScriptComponentResource, getStateManagementStrategy, getViewMetadata, renderView, retargetAttachedObjects, retargetMethodExpressions, viewExists

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewDeclarationLanguageBase

public ViewDeclarationLanguageBase()

Method Detail

createView

public UIViewRoot createView(FacesContext context,
                             String viewId)

Process the specification required algorithm that is generic to all PDL.

Specified by:

createView in class ViewDeclarationLanguage

Parameters:

context -

viewId -

restoreView

public UIViewRoot restoreView(FacesContext context,
                              String viewId)

Specified by:

restoreView in class ViewDeclarationLanguage

calculateViewId

protected abstract String calculateViewId(FacesContext context,
                                          String viewId)

Calculates the effective view identifier for the specified raw view identifier.

Parameters:

context - le current FacesContext

viewId - the raw view identifier

Returns:

the effective view identifier

sendSourceNotFound

protected abstract void sendSourceNotFound(FacesContext context,
                                           String message)

Send a source not found to the client. Although it can be considered ok in JSP mode, I think it's pretty lame to have this kind of requirement at VDL level considering VDL represents the page --> JSF tree link, not the transport layer required to send a SC_NOT_FOUND.

Parameters:

context - le current FacesContext

message - the message associated with the error

checkNull

protected void checkNull(Object o,
                         String param)

Check if the specified value of a param is null.

Parameters:

o - the parameter's value

param - the parameter's name

Throws:

NullPointerException - if the value is null