|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jibx.custom.CustomizationCommandLineBase
public abstract class CustomizationCommandLineBase
Command line processor for all types of customizable tools. This just provides the basic handling of a customizations file, target directory, and overrides of values in the customizations root object. TODO: should extend SchemaCommandLinebase
Nested Class Summary | |
---|---|
protected static class |
CustomizationCommandLineBase.ArgList
Wrapper class for command line argument list. |
Field Summary | |
---|---|
private static java.lang.String[] |
COMMON_USAGE_LINES
Ordered array of usage lines for parameters at this level. |
private java.util.List |
m_extraArgs
List of specified classes or files. |
private java.io.File |
m_generateDirectory
Target directory for output. |
private java.lang.String[] |
m_usageLines
Complete array of usage lines. |
private boolean |
m_verbose
Verbose output flag. |
static java.lang.Class[] |
STRING_PARAMETER_ARRAY
Array of method parameter classes for single String parameter. |
static java.lang.Class[] |
STRING_UNMARSHALLER_PARAMETER_ARRAY
Array of classes for String and unmarshaller parameters. |
private static int |
USAGE_UNIQUE_CHARS
Number of leading characters in usage lines checked for uniqueness. |
Constructor Summary | |
---|---|
protected |
CustomizationCommandLineBase(java.lang.String[] lines)
Constructor. |
Method Summary | |
---|---|
protected abstract java.util.Map |
applyOverrides(java.util.Map overmap)
Apply map of override values to customizations read from file or created as default. |
protected boolean |
checkParameter(CustomizationCommandLineBase.ArgList alist)
Check extension parameter. |
protected void |
finishParameters(CustomizationCommandLineBase.ArgList alist)
Finish processing of command line parameters. |
java.util.List |
getExtraArgs()
Get extra arguments from command line. |
java.io.File |
getGeneratePath()
Get generate directory. |
protected java.lang.String[] |
getUsageLines()
Get the usage lines describing command line parameters. |
boolean |
isVerbose()
Check if verbose output requested. |
protected abstract boolean |
loadCustomizations(java.lang.String path)
Load the customizations file. |
protected static java.lang.String[] |
mergeUsageLines(java.lang.String[] base,
java.lang.String[] adds)
Merge two arrays of strings, returning an ordered array containing all the strings from both provided arrays. |
abstract void |
printUsage()
Print usage information. |
boolean |
processArgs(java.lang.String[] args)
Process command line arguments array. |
static boolean |
putKeyValue(java.lang.String def,
java.util.Map map)
Set a key=value definition in a map. |
protected void |
verboseDetails()
Print any extension details. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.Class[] STRING_PARAMETER_ARRAY
public static final java.lang.Class[] STRING_UNMARSHALLER_PARAMETER_ARRAY
private static final int USAGE_UNIQUE_CHARS
private static final java.lang.String[] COMMON_USAGE_LINES
private final java.lang.String[] m_usageLines
private java.util.List m_extraArgs
private java.io.File m_generateDirectory
private boolean m_verbose
Constructor Detail |
---|
protected CustomizationCommandLineBase(java.lang.String[] lines)
lines
- Method Detail |
---|
public boolean processArgs(java.lang.String[] args) throws JiBXException, java.io.IOException
args
-
true
if valid, false
if not
JiBXException
java.io.IOException
public java.io.File getGeneratePath()
public java.util.List getExtraArgs()
public boolean isVerbose()
public static boolean putKeyValue(java.lang.String def, java.util.Map map)
def
- map
-
true
if successful, false
if errorprotected java.lang.String[] getUsageLines()
protected static java.lang.String[] mergeUsageLines(java.lang.String[] base, java.lang.String[] adds)
base
- adds
-
protected boolean checkParameter(CustomizationCommandLineBase.ArgList alist)
alist
- argument list
true
if parameter processed, false
if unknownprotected void finishParameters(CustomizationCommandLineBase.ArgList alist)
alist
- protected void verboseDetails()
protected abstract boolean loadCustomizations(java.lang.String path) throws JiBXException, java.io.IOException
path
- customization file path, null
if none
true
if successful, false
if an error
JiBXException
java.io.IOException
protected abstract java.util.Map applyOverrides(java.util.Map overmap)
overmap
- override key-value map
public abstract void printUsage()
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |