Java Doc for CommandLine.java in  » Testing » jacareto » jacareto » toolkit » 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 » Testing » jacareto » jacareto.toolkit 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   jacareto.toolkit.CommandLine

CommandLine
public class CommandLine (Code)
This class simplifies command line parameter handling.

At first you have to specify the valid arguments by calling the CommandLine.addValidArgument(String,int) method for each valid argument. After that, call the CommandLine.readArguments(String[]) method with the parameters of you main method for telling the command line instance the actual parameters. You can then get a value of a specified parameter by calling the CommandLine.getValue(String,int) method.

Example: This code would work for an application with the following command line syntax:

java myTool [-r] [-name Prename Surename] [-recordfile filename] filename

 try {
 CommandLine commandLine = new CommandLine();
 commandLine.addValidArgument ("r", 0);
 commandLine.addValidArgument ("name", 2);
 commandLine.addValidArgument ("recordfile", 1);
 commandLine.readArguments (args);
 if (commandLine.hasArgument ("name")) {
 String prename = commandLine.getValue ("name", 0);
 String surname = commandLine.getValue ("name", 1);
 ...
 }
 String filename = commandLine.getTail();
 ...
 } catch (CommandLineException c) {
 ...
 }
 


author:
   Christian Spannagel
version:
   0.9



Constructor Summary
public  CommandLine()
     Creates a new command line instance.

Method Summary
public  voidaddValidArgument(String argName, int numberOfValues)
     Adds a valid argument with a specified number of values to the list of valid arguments.
public  CollectiongetTail()
     Returns the tail of the command line as collection.
public  StringgetValue(String arg, int number)
     Returns the value of a specified argument at a specified position.
public  booleanhasArgument(String arg)
     Returns if the command line contains the specified argument.
public  voidreadArguments(String[] args)
    
public static  String[]toParameterArray(String parameterLine)
     Converts a parameter line (as String) to an array of Strings.
public  StringtoString()
     Returns the command line instance as string representation.


Constructor Detail
CommandLine
public CommandLine()(Code)
Creates a new command line instance.




Method Detail
addValidArgument
public void addValidArgument(String argName, int numberOfValues)(Code)
Adds a valid argument with a specified number of values to the list of valid arguments.
Parameters:
  argName - the name of the argument
Parameters:
  numberOfValues - the number of values (0 for an argument without values).



getTail
public Collection getTail()(Code)
Returns the tail of the command line as collection. DOCUMENT ME!



getValue
public String getValue(String arg, int number) throws CommandLineException(Code)
Returns the value of a specified argument at a specified position.
Parameters:
  arg - the name of the argument
Parameters:
  number - the number of the value (beginning with 0) the value
throws:
  CommandLineException - if the name of the position is not valid



hasArgument
public boolean hasArgument(String arg)(Code)
Returns if the command line contains the specified argument.
Parameters:
  arg - the name of the argument true or false :-)



readArguments
public void readArguments(String[] args) throws CommandLineException(Code)
Delivers the arguments of the main method to the command line instance
Parameters:
  args - the arguments of the main method
throws:
  CommandLineException - if the command line is not ok



toParameterArray
public static String[] toParameterArray(String parameterLine)(Code)
Converts a parameter line (as String) to an array of Strings. The conversion is very simple at the moment. The String is just splitted at the blanks.
Parameters:
  parameterLine - the parameters as String the parameters, as elements of a String array



toString
public String toString()(Code)
Returns the command line instance as string representation. the string



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.