Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.milligan.eccles
Class EcclesReturnValue  view EcclesReturnValue download EcclesReturnValue.java

java.lang.Object
  extended byorg.milligan.eccles.EcclesReturnValue

public class EcclesReturnValue
extends java.lang.Object

Definition of a return value from a tag with optional additional information.


Field Summary
static int CODE_BREAK
          Break processing and return to a parent tag.
static int CODE_CONTINUE_PROCESSING
          Contine processing with the next sibling.
static int CODE_EXCEPTION
          An exception has been thrown, go up the stack to an exception handler
static int CODE_PROCESS_CHILDREN
          Continue and process children.
static int CODE_SKIP_CHILDREN
           
private  EcclesException exception
          The string property.
private  int returnValue
          The return value code
private  java.lang.String string
          The string property.
 
Constructor Summary
EcclesReturnValue(int rv)
           
EcclesReturnValue(int rv, EcclesException exception)
           
EcclesReturnValue(int rv, java.lang.String string)
           
 
Method Summary
 EcclesException getException()
           
 int getReturnValue()
           
 java.lang.String getString()
           
 boolean isBreakOrException()
           
 boolean isException()
           
 void setException(EcclesException exception)
           
 void setReturnValue(int returnValue)
           
 void setString(java.lang.String string)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CODE_SKIP_CHILDREN

public static final int CODE_SKIP_CHILDREN
See Also:
Constant Field Values

CODE_PROCESS_CHILDREN

public static final int CODE_PROCESS_CHILDREN
Continue and process children. Valid return from doStartTag and doAfterChildren

See Also:
Constant Field Values

CODE_CONTINUE_PROCESSING

public static final int CODE_CONTINUE_PROCESSING
Contine processing with the next sibling. Valid return from doEndTag

See Also:
Constant Field Values

CODE_BREAK

public static final int CODE_BREAK
Break processing and return to a parent tag. Valid return from doEndTag

See Also:
Constant Field Values

CODE_EXCEPTION

public static final int CODE_EXCEPTION
An exception has been thrown, go up the stack to an exception handler

See Also:
Constant Field Values

returnValue

private int returnValue
The return value code


string

private java.lang.String string
The string property. Valid for use when the return value code is
CODE_BREAK. Value = id of tag to break to or null for nearest


exception

private EcclesException exception
The string property. Valid for use when the return value code is
CODE_EXCEPTION

Constructor Detail

EcclesReturnValue

public EcclesReturnValue(int rv)

EcclesReturnValue

public EcclesReturnValue(int rv,
                         java.lang.String string)

EcclesReturnValue

public EcclesReturnValue(int rv,
                         EcclesException exception)
Method Detail

getReturnValue

public int getReturnValue()

setReturnValue

public void setReturnValue(int returnValue)

setString

public void setString(java.lang.String string)

getString

public java.lang.String getString()

setException

public void setException(EcclesException exception)

getException

public EcclesException getException()

isBreakOrException

public boolean isBreakOrException()

isException

public boolean isException()