org.directwebremoting.dwrp
Class NonJsonNestedOutboundVariable

java.lang.Object
  org.directwebremoting.dwrp.NonJsonNestedOutboundVariable

All Implemented Interfaces:

OutboundVariable

Direct Known Subclasses:

ArrayNonJsonOutboundVariable, ObjectNonJsonOutboundVariable

public abstract class NonJsonNestedOutboundVariable
extends java.lang.Object
implements OutboundVariable

A helper class for people that want to implement OutboundVariable.

Author:

Joe Walker [joe at getahead dot ltd dot uk]

Method Summary

java.lang.String	getAssignCode() A short script that can be used to refer to this variable
java.lang.String	getBuildCode() A script that completes the definition of this variable, and may contain reference to other declared variables.
java.lang.String	getDeclareCode() A script to declare the variable so it can be referred to.
OutboundVariable	getReferenceVariable() Get a reference to this OutboundVariable.
boolean	isOutline()
void	setAssignCode(java.lang.String assignCode)
void	setBaseBuildCode(java.lang.String buildCode)
void	setBaseDeclareCode(java.lang.String declareCode)
void	setChildren(java.util.Collection<OutboundVariable> children) When we create buildCode and declareCode, what do we need to add?

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.directwebremoting.extend.OutboundVariable

prepareAssignCode, prepareBuildDeclareCodes

Method Detail

isOutline

public boolean isOutline()

Returns:

the outline

getDeclareCode

public java.lang.String getDeclareCode()

Description copied from interface: OutboundVariable

A script to declare the variable so it can be referred to. This script is guaranteed not to refer to anything that can recurse

Specified by:

getDeclareCode in interface OutboundVariable

Returns:

Returns the declareCode

setBaseDeclareCode

public void setBaseDeclareCode(java.lang.String declareCode)

Parameters:

declareCode - the declareCode to set

getBuildCode

public java.lang.String getBuildCode()

Description copied from interface: OutboundVariable

A script that completes the definition of this variable, and may contain reference to other declared variables.

Specified by:

getBuildCode in interface OutboundVariable

Returns:

Returns the buildCode.

setBaseBuildCode

public void setBaseBuildCode(java.lang.String buildCode)

Parameters:

buildCode - the buildCode to set

getAssignCode

public java.lang.String getAssignCode()

Description copied from interface: OutboundVariable

A short script that can be used to refer to this variable

Specified by:

getAssignCode in interface OutboundVariable

Returns:

Returns the assignCode.

setAssignCode

public void setAssignCode(java.lang.String assignCode)

Parameters:

assignCode - the assignCode to set

getReferenceVariable

public OutboundVariable getReferenceVariable()

Description copied from interface: OutboundVariable

Get a reference to this OutboundVariable. If this already is a reference then this method returns this, or if not it creates one that does.

Specified by:

getReferenceVariable in interface OutboundVariable

Returns:

An OutboundVariable that refers to this one.

setChildren

public void setChildren(java.util.Collection<OutboundVariable> children)

When we create buildCode and declareCode, what do we need to add?

Parameters:

children - The list of dependent OutboundVariables