org.webmacro.directive
Class Directive.ArgDescriptor

java.lang.Object
  |
  +--org.webmacro.directive.Directive.ArgDescriptor
Direct Known Subclasses:
Directive.AssignmentArg, Directive.BlockArg, Directive.ConditionArg, Directive.KeywordArg, Directive.LiteralBlockArg, Directive.LValueArg, Directive.OptionalGroup, Directive.OptionChoice, Directive.QuotedStringArg, Directive.RValueArg, Directive.StringArg, Directive.Subdirective
Enclosing class:
Directive

public abstract static class Directive.ArgDescriptor
extends java.lang.Object

ArgDescriptor is the base class for all the different types of argument descriptors, like ConditionalArg, KeywordArg, RValueArg, etc. Most ArgDescriptor constructors take an argId parameter, which is an integer which uniquely identifies the argument which will be passed to DirectiveBuilder.getArg when retrieving the argument.


Field Summary
 int[] children
           
 int id
           
 java.lang.String keyword
           
 int nextArg
           
 boolean optional
           
 int subordinateArgs
           
 int type
           
 
Constructor Summary
protected Directive.ArgDescriptor(int id, int type)
           
 
Method Summary
protected  void setOptional()
           
protected  void setOptional(int subordinateArgs)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

id

public final int id

type

public final int type

optional

public boolean optional

subordinateArgs

public int subordinateArgs

nextArg

public int nextArg

children

public int[] children

keyword

public java.lang.String keyword
Constructor Detail

Directive.ArgDescriptor

protected Directive.ArgDescriptor(int id,
                                  int type)
Method Detail

setOptional

protected void setOptional()

setOptional

protected void setOptional(int subordinateArgs)