Package org.jibx.custom.classes
Class ClassCustomizationBase
java.lang.Object
org.jibx.custom.CustomizationCommandLineBase
org.jibx.custom.classes.ClassCustomizationBase
- Direct Known Subclasses:
SchemaGenCommandLine
Command line processor for customizable tools working with Java classes.
- Author:
- Dennis M. Sosnoski
-
Nested Class Summary
Nested classes/interfaces inherited from class org.jibx.custom.CustomizationCommandLineBase
CustomizationCommandLineBase.ArgList -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String[]Ordered array of usage lines.private ListList of class paths.private ListList of source paths.Fields inherited from class org.jibx.custom.CustomizationCommandLineBase
STRING_PARAMETER_ARRAY, STRING_UNMARSHALLER_PARAMETER_ARRAY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanCheck if an extension parameter is recognized.protected voidFinish processing of command line parameters.protected booleanloadCustomizations(String path) Load the customizations file.protected abstract voidloadCustomizations(String path, IClassLocator loc, ValidationContext vctx) Load the customizations file.protected static voidsplitItems(String text, List values) Split items from a comma-delimited list.protected voidPrint any extension details.Methods inherited from class org.jibx.custom.CustomizationCommandLineBase
applyOverrides, getExtraArgs, getGeneratePath, getUsageLines, isVerbose, mergeUsageLines, printUsage, processArgs, putKeyValue
-
Field Details
-
BASE_USAGE_LINES
Ordered array of usage lines. -
m_classPaths
List of class paths. -
m_sourcePaths
List of source paths.
-
-
Constructor Details
-
ClassCustomizationBase
Constructor.- Parameters:
lines-
-
-
Method Details
-
splitItems
Split items from a comma-delimited list.- Parameters:
text- comma-delimited listvalues- target list of item values
-
checkParameter
Check if an extension parameter is recognized. Subclasses which override this method should call the base class method before doing their own checks, and only perform their own checks if this method returnsfalse..- Overrides:
checkParameterin classCustomizationCommandLineBase- Parameters:
alist- argument list- Returns:
trueif parameter processed,falseif unknown
-
finishParameters
Finish processing of command line parameters. This adds the JVM classpath directories to the set of paths specified on the command line. Subclasses which override this method need to call this base class implementation as part of their processing.- Overrides:
finishParametersin classCustomizationCommandLineBase- Parameters:
alist-
-
verboseDetails
protected void verboseDetails()Print any extension details. This method may be overridden by subclasses to print extension parameter values for verbose output, but the base class implementation should be called first.- Overrides:
verboseDetailsin classCustomizationCommandLineBase
-
loadCustomizations
Load the customizations file. This method must load the specified customizations file, or create a default customizations instance, of the appropriate type.- Specified by:
loadCustomizationsin classCustomizationCommandLineBase- Parameters:
path- customization file path- Returns:
trueif successful,falseif an error- Throws:
JiBXExceptionIOException
-
loadCustomizations
protected abstract void loadCustomizations(String path, IClassLocator loc, ValidationContext vctx) throws JiBXException, IOException Load the customizations file. This method must load the specified customizations file, or create a default customizations instance, of the appropriate type.- Parameters:
path- customizations file path,nullif noneloc- class locatorvctx- validation context- Throws:
JiBXExceptionIOException
-