org.vishia.util

Class FileList.Args

java.lang.Object

org.vishia.util.Arguments

org.vishia.util.FileList.Args

Enclosing class:

FileList

public static class FileList.Args
extends Arguments

Nested Class Summary

Nested classes/interfaces inherited from class org.vishia.util.Arguments

Arguments.Argument, Arguments.SetArgument

Field Summary

Fields

Modifier and Type	Field and Description
char	cCmd
boolean	crc
java.lang.Appendable	out Any output for operation.
java.lang.String	sDirectory Directory where the list is regarded to.
(package private) Arguments.SetArgument	setCmd
(package private) Arguments.SetArgument	setDir
(package private) Arguments.SetArgument	setListfile
(package private) Arguments.SetArgument	setMask
java.lang.String	sFileList Name, maybe path of the file list relative to sDirectory.
java.lang.String	sMask

Fields inherited from class org.vishia.util.Arguments

aboutInfo, argList, exitCodeArgError, helpInfo, outMsg, sLogLevel, sLogPath, sVersion

Constructor Summary

Constructors

Constructor and Description
Args()

Method Summary

Modifier and Type	Method and Description
boolean	testConsistence(java.lang.Appendable msg) This operation should be implemented and called by the user.

Methods inherited from class org.vishia.util.Arguments

aboutInfo, addArg, checkArg, checkArgVal, parseArgs, parseArgs, readArguments, replaceEnv, showHelp, testArgument

Methods inherited from class java.lang.Object

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

Field Detail

cCmd

public char cCmd

sDirectory

public java.lang.String sDirectory

Directory where the list is regarded to.

sMask

public java.lang.String sMask

out

public java.lang.Appendable out

Any output for operation. One line per file. Maybe null to prevent output.

crc

public boolean crc

sFileList

public java.lang.String sFileList

Name, maybe path of the file list relative to sDirectory.

setCmd

Arguments.SetArgument setCmd

setListfile

Arguments.SetArgument setListfile

setDir

Arguments.SetArgument setDir

setMask

Arguments.SetArgument setMask

Constructor Detail

Args

Args()

Method Detail

testConsistence

public boolean testConsistence(java.lang.Appendable msg)
                        throws java.io.IOException

Description copied from class: Arguments

This operation should be implemented and called by the user. It should check the consistency of the given arguments as it is need by the application and may also prepare some derived arguments, for example .
Implementation hint: This operation may invoke #showArgs(Appendable) to output the help info on error.

Specified by:

testConsistence in class Arguments

Parameters:

msg - to write out an info as line with \n for faulty arguments. System.err can be used.

Returns:

true if consistent.

Throws:

java.io.IOException - only on unexpected problems writing msg