org.jibx.custom.classes

Class ClassCustomizationBase

java.lang.Object

org.jibx.custom.CustomizationCommandLineBase

org.jibx.custom.classes.ClassCustomizationBase

Direct Known Subclasses:

SchemaGenCommandLine

public abstract class ClassCustomizationBase
extends CustomizationCommandLineBase

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

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	BASE_USAGE_LINES Ordered array of usage lines.
private java.util.List	m_classPaths List of class paths.
private java.util.List	m_sourcePaths List of source paths.

Fields inherited from class org.jibx.custom.CustomizationCommandLineBase

STRING_PARAMETER_ARRAY, STRING_UNMARSHALLER_PARAMETER_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClassCustomizationBase(java.lang.String[] lines) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkParameter(CustomizationCommandLineBase.ArgList alist) Check if an extension parameter is recognized.
protected void	finishParameters(CustomizationCommandLineBase.ArgList alist) Finish processing of command line parameters.
protected boolean	loadCustomizations(java.lang.String path) Load the customizations file.
protected abstract void	loadCustomizations(java.lang.String path, IClassLocator loc, ValidationContext vctx) Load the customizations file.
protected static void	splitItems(java.lang.String text, java.util.List values) Split items from a comma-delimited list.
protected void	verboseDetails() Print any extension details.

Methods inherited from class org.jibx.custom.CustomizationCommandLineBase

applyOverrides, getExtraArgs, getGeneratePath, getUsageLines, isVerbose, mergeUsageLines, printUsage, processArgs, putKeyValue

Methods inherited from class java.lang.Object

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

Field Detail

BASE_USAGE_LINES

private static final java.lang.String[] BASE_USAGE_LINES

Ordered array of usage lines.

m_classPaths

private java.util.List m_classPaths

List of class paths.

m_sourcePaths

private java.util.List m_sourcePaths

List of source paths.

Constructor Detail

ClassCustomizationBase

protected ClassCustomizationBase(java.lang.String[] lines)

Constructor.

Parameters:

lines -

Method Detail

splitItems

protected static void splitItems(java.lang.String text,
              java.util.List values)

Split items from a comma-delimited list.

Parameters:

text - comma-delimited list

values - target list of item values

checkParameter

protected boolean checkParameter(CustomizationCommandLineBase.ArgList alist)

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 returns false..

Overrides:

checkParameter in class CustomizationCommandLineBase

Parameters:

alist - argument list

Returns:

true if parameter processed, false if unknown

finishParameters

protected void finishParameters(CustomizationCommandLineBase.ArgList alist)

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:

finishParameters in class CustomizationCommandLineBase

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:

verboseDetails in class CustomizationCommandLineBase

loadCustomizations

protected boolean loadCustomizations(java.lang.String path)
                              throws JiBXException,
                                     java.io.IOException

Load the customizations file. This method must load the specified customizations file, or create a default customizations instance, of the appropriate type.

Specified by:

loadCustomizations in class CustomizationCommandLineBase

Parameters:

path - customization file path

Returns:

true if successful, false if an error

Throws:

JiBXException

java.io.IOException

loadCustomizations

protected abstract void loadCustomizations(java.lang.String path,
                      IClassLocator loc,
                      ValidationContext vctx)
                                    throws JiBXException,
                                           java.io.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, null if none

loc - class locator

vctx - validation context

Throws:

JiBXException

java.io.IOException