org.vishia.mainCmd

Class SampleCmdLine

java.lang.Object

org.vishia.mainCmd.SampleCmdLine

public class SampleCmdLine
extends java.lang.Object

Sample for a main-class for a application using MainCmd-super-class.....
This is a sample and an example. The user should do the followed to use the class as a template:

• copy this file under the requested name and package
• adapt the package line
• replace 'CmdLineSample' with the user's main class name
• look on all :TODO: -location and change/complete the source there

You can adapt and change one after another.

The toplevel class contains three static sub classes and the main routine. The sub classes may be written in extra files in the same package instead. Because there are static, it's easy.

The three inner classes are:

• The class SampleCmdLine.UserMain is an example for the user's class. It contains some less statements to show what's work but it does not contain essential code.
• A SampleCmdLine.Args class to hold the data from the cmd line invocation in a proper form or some other values too. This class may be an independent mediator between an independent SampleCmdLine.UserMain and the MainCmd implementor.
• The class SampleCmdLine.CmdLine is derived from MainCmd and implements the command line invocation necessities of this example.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	SampleCmdLine.Args This class holds the got arguments from command line.
(package private) static class	SampleCmdLine.CmdLine The inner class CmdLine helps to evaluate the command line arguments and show help messages on command line.
static class	SampleCmdLine.UserMain This class represents a user's class.

Field Summary

Fields

Modifier and Type	Field and Description
static int	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
SampleCmdLine()

Method Summary

Modifier and Type	Method and Description
static void	main(java.lang.String[] cmdlineargs) main started from java

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final int version

Version, history and license.

• 2013-02-23 Hartmut chg: SampleCmdLine.UserMain as extra inner class, LogMessage, commented.
• 2009-03-21: Hartmut The parsed arguments are written in an extra static class Args, it is better and it is more structured. The application can read arguments via knowledge only of this class, without dependencies of the other code. The arguments may be supplied or corrected also with other algorithm.
• 2009-03-21: Hartmut The class CmdLine based on MainCmd is static. This class is only a definition wrapper. The application can/should use this class non-depended from arguments etc. via MainCmd_ifc.
• 2009-03-21: Hartmut The main-method instantiates at first only the classes SampleCmdLine.CmdLine and the SampleCmdLine.Args but not the main class itself, because the Main-class of the application may got some other aggregates, which may created first and outside (dependency injection, inside using final). It is also possible to create more as one classes in SampleCmdLine#reflexAccessSfc, especially SampleCmdLine may only be an empty wrapper for organization of main, Args and MainCmd, without deeper dependencies to the core application.

Copyright/Copyleft:
Because this class is a template only, you can use a copy without any license notification. For the original code the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but doesn't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

See Also:

Constant Field Values

Constructor Detail

SampleCmdLine

public SampleCmdLine()

Method Detail

main

public static void main(java.lang.String[] cmdlineargs)

main started from java