org.apache.myfaces.custom.aliasbean
Class Alias

java.lang.Object
  org.apache.myfaces.custom.aliasbean.Alias

 class Alias
extends java.lang.Object

A helper bean used by both AliasBean and AliasBeansScope components.

An Alias instance represents a single mapping from a "temporary" bean name to the real bean that temporary name should reference. When this alias is "activated" the temporary name is registered and when the alias is "deactivated" the temporary name is removed.

Version:

$Revision: 598223 $ $Date: 2007-11-26 12:04:31 +0100 (Mon, 26 Nov 2007) $

Author:

Sylvain Vieujot (latest modification by $Author: skitching $)

Field Summary

(package private) static org.apache.commons.logging.Log

log

Constructor Summary

Alias(AliasBean aliasComponent)

Method Summary

(package private) java.lang.String	getValueExpression()
(package private) boolean	isActive()
(package private) void	make(javax.faces.context.FacesContext facesContext) Activate this alias (ie create the temporary name).
(package private) void	remove(javax.faces.context.FacesContext facesContext) Deactivate this alias (ie remove the temporary name).
(package private) void	restoreState(java.lang.Object state)
(package private) java.lang.String[]	saveState()
(package private) void	setAliasBeanExpression(java.lang.String aliasBeanExpression) Define the temporary/transient name that will exist while this alias is "active" (in scope).
(package private) void	setValueExpression(java.lang.String valueExpression) Define the object that will be referenced by the temporary/transient name while it exists.

Methods inherited from class java.lang.Object

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

Field Detail

log

static final org.apache.commons.logging.Log log

Constructor Detail

Alias

Alias(AliasBean aliasComponent)

Method Detail

setAliasBeanExpression

void setAliasBeanExpression(java.lang.String aliasBeanExpression)

Define the temporary/transient name that will exist while this alias is "active" (in scope). This is usually a constant string.

setValueExpression

void setValueExpression(java.lang.String valueExpression)

Define the object that will be referenced by the temporary/transient name while it exists.

This can be a constant, but is more usually an EL expression. The value is recalculated each time this alias is "activated".

getValueExpression

java.lang.String getValueExpression()

isActive

boolean isActive()

saveState

java.lang.String[] saveState()

restoreState

void restoreState(java.lang.Object state)

make

void make(javax.faces.context.FacesContext facesContext)

Activate this alias (ie create the temporary name).

remove

void remove(javax.faces.context.FacesContext facesContext)

Deactivate this alias (ie remove the temporary name).