Java Doc for Argument.java in  » Workflow-Engines » pegasus-2.1.0 » org » griphyn » vdl » classes » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Workflow Engines » pegasus 2.1.0 » org.griphyn.vdl.classes   Source Cross Reference   Class Diagram   Java Document (Java Doc)   org.griphyn.vdl.classes.VDL    org.griphyn.vdl.classes.Argument Argument public class Argument extends VDL implements Serializable(Code) A class to encapsulate a command line argument line. The command line is separated into a list of distinct fragments. Each fragment can only be of type Use or Text. author:    Jens-S. Vöckler author:    Yong Zhao version:    $Revision: 50 $ See Also:   Leaf See Also:   Text See Also:   Use Constructor Summary public   Argument()      Array ctor. public   Argument(String name)      Standard ctor: Constructs a named Argument group. public   Argument(String name, Leaf firstChild)      Convenience ctor: Constructs a name argument group, and enters the first (and possibly only) fragment into the group. Parameters:   name - is the unique identifier for the argument group. Parameters:   firstChild - is the element to place into the argument group. Method Summary public  void addLeaf(Leaf vLeaf)      Accessor: Appends a commandline fragment to the current group. Parameters:   vLeaf - is the fragment to add. public  void addLeaf(int index, Leaf vLeaf)      Accessor: Inserts a Leaf value into a specific position of this commandline group. Parameters:   index - is the position to insert the item into Parameters:   vLeaf - is the value to append to the list. public  Enumeration enumerateLeaf()      Accessor: Enumerates the internal values that constitute the content this commandline group. public  Leaf getLeaf(int index)      Accessor: Obtains the Leaf at a certain position in the commandline argument group. public  Leaf[] getLeaf()      Accessor: Gets an array of all values that constitute the current value content of this commandline group. public  int getLeafCount()      Accessor: Obtains the size of the commandline group. public  java.util.List getLeafList()      Accessor: Gets an array of all values that constitute the current content. public  String getName()      Accessor: Obtains the current name of this commandline group. public  Iterator iterateLeaf()      Accessor: Enumerates the internal values that constitute the content of the Scalar element. public  ListIterator listIterateLeaf()      Accessor: Enumerates the internal values that constitute the content of the Scalar element. public  ListIterator listIterateLeaf(int start)      Accessor: Enumerates the internal values that constitute the content of the Scalar element. public  void removeAllLeaf()      Accessor: Removes all values from this commandline group. public  Leaf removeLeaf(int index)      Accessor: Removes a specific fragment from this commandline group. Parameters:   index - is the position at which an element is to be removed. public  void setLeaf(int index, Leaf vLeaf)      Accessor: Overwrites a Use or Text value fragment at a certain position in this command line group. public  void setLeaf(Leaf[] leafArray)      Accessor: Replaces the commandline group with another group value. public  void setLeaf(Collection leaves)      Accessor: Overwrites internal list with an external list representing a Scalar value. public  void setName(String name)      Accessor: Replaces or sets the current identifier for this commandline group. public  void toString(Writer stream)      Converts the commandline group into textual format for human consumption. Parameters:   stream - is a stream opened and ready for writing. public  void toXML(Writer stream, String indent, String namespace)      Dump the state of the current element as XML output. Constructor Detail Argument public Argument()(Code) Array ctor. Argument public Argument(String name)(Code) Standard ctor: Constructs a named Argument group. Parameters:   name - is the identifier for the argument group. Argument public Argument(String name, Leaf firstChild)(Code) Convenience ctor: Constructs a name argument group, and enters the first (and possibly only) fragment into the group. Parameters:   name - is the unique identifier for the argument group. Parameters:   firstChild - is the element to place into the argument group. OnlyLeafs of type Use or Textare permissable. See Also:   Leaf See Also:   Use See Also:   Text Method Detail addLeaf public void addLeaf(Leaf vLeaf) throws IndexOutOfBoundsException, IllegalArgumentException(Code) Accessor: Appends a commandline fragment to the current group. Parameters:   vLeaf - is the fragment to add. Note that only leaf values ofUse or Text are allowed. throws:   IndexOutOfBoundsException - if the value cannot be added. throws:   IllegalArgumentException - if the value type is neitherUse nor Text. See Also:   Leaf See Also:   Text See Also:   Use addLeaf public void addLeaf(int index, Leaf vLeaf) throws IndexOutOfBoundsException, IllegalArgumentException(Code) Accessor: Inserts a Leaf value into a specific position of this commandline group. Parameters:   index - is the position to insert the item into Parameters:   vLeaf - is the value to append to the list. Note that only leafvalues of Use or Text are allowed. throws:   IndexOutOfBoundsException - if the value cannot be added. throws:   IllegalArgumentException - if the value type is neitherUse nor Text. See Also:   Text See Also:   Use enumerateLeaf public Enumeration enumerateLeaf()(Code) Accessor: Enumerates the internal values that constitute the content this commandline group. the iterator to the commandline group internal list. getLeaf public Leaf getLeaf(int index) throws IndexOutOfBoundsException(Code) Accessor: Obtains the Leaf at a certain position in the commandline argument group. Parameters:   index - is the position in the list to obtain a value from The Use or Text at the position. throws:   IndexOutOfBoundsException - if the index points to an elementin the list that does not contain any elments. See Also:   Use See Also:   Text getLeaf public Leaf[] getLeaf()(Code) Accessor: Gets an array of all values that constitute the current value content of this commandline group. This array is a copy to avoid write-through modifications. an array with a mixture of either Text orUse values. See Also:   Use See Also:   Text See Also:    getLeafCount public int getLeafCount()(Code) Accessor: Obtains the size of the commandline group. number of elements that an external array needs to be sized to. getLeafList public java.util.List getLeafList()(Code) Accessor: Gets an array of all values that constitute the current content. This list is read-only. an array with a mixture of either Text orLFN values. See Also:   LFN See Also:   Text getName public String getName()(Code) Accessor: Obtains the current name of this commandline group. the name of this commandline group. See Also:   Argument.setName(java.lang.String) iterateLeaf public Iterator iterateLeaf()(Code) Accessor: Enumerates the internal values that constitute the content of the Scalar element. an iterator to walk the list with. listIterateLeaf public ListIterator listIterateLeaf()(Code) Accessor: Enumerates the internal values that constitute the content of the Scalar element. an enumeration to walk the list with. listIterateLeaf public ListIterator listIterateLeaf(int start)(Code) Accessor: Enumerates the internal values that constitute the content of the Scalar element. Parameters:   start - is the start index an enumeration to walk the list with. removeAllLeaf public void removeAllLeaf()(Code) Accessor: Removes all values from this commandline group. removeLeaf public Leaf removeLeaf(int index)(Code) Accessor: Removes a specific fragment from this commandline group. Parameters:   index - is the position at which an element is to be removed. the object that was removed. The removed item is either anUse or a Text. See Also:   Use See Also:   Text setLeaf public void setLeaf(int index, Leaf vLeaf) throws IndexOutOfBoundsException, IllegalArgumentException(Code) Accessor: Overwrites a Use or Text value fragment at a certain position in this command line group. Parameters:   index - position to overwrite an elment in. Parameters:   vLeaf - is either a Use or Text object. throws:   IndexOutOfBoundsException - if the position pointed to is invalid. throws:   IllegalArgumentException - if the added element is of theincorrect Leaf type. See Also:   Use See Also:   Text setLeaf public void setLeaf(Leaf[] leafArray)(Code) Accessor: Replaces the commandline group with another group value. Warning: The replacements are not checked for being of the correct leaf types. Parameters:   leafArray - is the external list of Text orUse objects used to overwrite things. See Also:   Text See Also:   Use setLeaf public void setLeaf(Collection leaves)(Code) Accessor: Overwrites internal list with an external list representing a Scalar value. Parameters:   leaves - is the external list of Text orLFN objects used to overwrite things. See Also:   Text See Also:   LFN setName public void setName(String name)(Code) Accessor: Replaces or sets the current identifier for this commandline group. Parameters:   name - is the new identifier to use for this commandline group. See Also:   Argument.getName() toString public void toString(Writer stream) throws IOException(Code) Converts the commandline group into textual format for human consumption. Parameters:   stream - is a stream opened and ready for writing. This can alsobe a string stream for efficient output. exception:   IOException - if something fishy happens to the stream. toXML public void toXML(Writer stream, String indent, String namespace) throws IOException(Code) Dump the state of the current element as XML output. This function traverses all sibling classes as necessary, and converts the data into pretty-printed XML output. The stream interface should be able to handle large output efficiently, if you use a buffered writer. Parameters:   stream - is a stream opened and ready for writing. This can alsobe a string stream for efficient output. Parameters:   indent - is a String of spaces used for prettyprinting. The initial amount of spaces should be an empty string.The parameter is used internally for the recursive traversal.If a null value is specified, no indentation norlinefeeds will be generated. Parameters:   namespace - is the XML schema namespace prefix. If neitherempty nor null, each element will be prefixed with this prefix,and the root element will map the XML namespace. exception:   IOException - if something fishy happens to the stream.