org.jibx.schema.codegen

Class CodeGenCommandLine

java.lang.Object

org.jibx.custom.CustomizationCommandLineBase

org.jibx.schema.codegen.CodeGenCommandLine

public class CodeGenCommandLine
extends CustomizationCommandLineBase

Command line processing specifically for the CodeGen class.

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[]	EXTRA_USAGE_LINES Ordered array of extra usage lines.
private java.lang.String	m_bindingName Name used for root binding.
private SchemasetCustom	m_customRoot Customizations model root.
private java.lang.String	m_defaultPackage Default package for all schemas.
private java.io.File	m_differenceFile File for checking differences in generated class structure (null if none).
private java.util.List	m_includePaths List of existing bindings to be included and used for matching schema definitions.
private java.io.File	m_modelFile File for dumping the generated class structure (null if none).
private java.lang.String	m_nonamespacePackage Default package for no-namespace schemas.
private java.lang.String	m_rootPath Schema root path.
private java.io.File	m_schemaDir Root directory for schemas (null if not a file system root).
private java.net.URL	m_schemaRoot Root URL for schemas.
private java.lang.String	m_usingNamespace Namespace to be used for no-namespace schemas generated directly.
private static Logger	s_logger Logger for class.

Fields inherited from class org.jibx.custom.CustomizationCommandLineBase

STRING_PARAMETER_ARRAY, STRING_UNMARSHALLER_PARAMETER_ARRAY

Constructor Summary

Constructors

Constructor and Description
CodeGenCommandLine() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected 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.lang.String	getBindingName() Get binding name.
SchemasetCustom	getCustomRoot() Get customizations model root.
java.io.File	getDifferenceFile() Get file to be used for finding differences in generated data model.
java.util.List	getIncludePaths() Get the list of paths for bindings to be used for matching schema definitions.
java.io.File	getModelFile() Get file to be used for dumping generated data model.
java.lang.String	getNonamespacePackage() Get default package for no-namespace schemas.
java.io.File	getSchemaDir() Get root directory for schemas.
java.net.URL	getSchemaRoot() Get root URL for schemas.
java.lang.String	getUsingNamespace() Get namespace to be used when no schemas with namespaces are being generated.
protected boolean	loadCustomizations(java.lang.String path) Load the customizations file.
void	printUsage() Print usage information.

Methods inherited from class org.jibx.custom.CustomizationCommandLineBase

getExtraArgs, getGeneratePath, getUsageLines, isVerbose, mergeUsageLines, processArgs, putKeyValue, verboseDetails

Methods inherited from class java.lang.Object

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

Field Detail

s_logger

private static final Logger s_logger

Logger for class.

EXTRA_USAGE_LINES

private static final java.lang.String[] EXTRA_USAGE_LINES

Ordered array of extra usage lines.

m_nonamespacePackage

private java.lang.String m_nonamespacePackage

Default package for no-namespace schemas.

m_defaultPackage

private java.lang.String m_defaultPackage

Default package for all schemas.

m_rootPath

private java.lang.String m_rootPath

Schema root path.

m_bindingName

private java.lang.String m_bindingName

Name used for root binding.

m_usingNamespace

private java.lang.String m_usingNamespace

Namespace to be used for no-namespace schemas generated directly.

m_schemaRoot

private java.net.URL m_schemaRoot

Root URL for schemas.

m_schemaDir

private java.io.File m_schemaDir

Root directory for schemas (null if not a file system root).

m_modelFile

private java.io.File m_modelFile

File for dumping the generated class structure (null if none).

m_differenceFile

private java.io.File m_differenceFile

File for checking differences in generated class structure (null if none).

m_customRoot

private SchemasetCustom m_customRoot

Customizations model root.

m_includePaths

private java.util.List m_includePaths

List of existing bindings to be included and used for matching schema definitions.

Constructor Detail

CodeGenCommandLine

public CodeGenCommandLine()

Constructor.

Method Detail

getSchemaRoot

public java.net.URL getSchemaRoot()

Get root URL for schemas.

Returns:

directory

getSchemaDir

public java.io.File getSchemaDir()

Get root directory for schemas.

Returns:

directory (null if root is not a directory)

getBindingName

public java.lang.String getBindingName()

Get binding name.

Returns:

name (null if not set)

getUsingNamespace

public java.lang.String getUsingNamespace()

Get namespace to be used when no schemas with namespaces are being generated.

Returns:

namespace URI (null if unspecified)

getCustomRoot

public SchemasetCustom getCustomRoot()

Get customizations model root.

Returns:

customizations

getNonamespacePackage

public java.lang.String getNonamespacePackage()

Get default package for no-namespace schemas.

Returns:

package (null if not set)

getModelFile

public java.io.File getModelFile()

Get file to be used for dumping generated data model.

Returns:

dump file (null if none)

getDifferenceFile

public java.io.File getDifferenceFile()

Get file to be used for finding differences in generated data model.

Returns:

difference file (null if none)

getIncludePaths

public java.util.List getIncludePaths()

Get the list of paths for bindings to be used for matching schema definitions.

Returns:

paths (empty if no paths specified)

checkParameter

protected boolean checkParameter(CustomizationCommandLineBase.ArgList alist)

Description copied from class: CustomizationCommandLineBase

Check extension parameter. This method may be overridden by subclasses to process parameters beyond those known to this base class.

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 just sets up the schema directory.

Overrides:

finishParameters in class CustomizationCommandLineBase

Parameters:

alist -

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

applyOverrides

protected java.util.Map applyOverrides(java.util.Map overmap)

Description copied from class: CustomizationCommandLineBase

Apply map of override values to customizations read from file or created as default.

Specified by:

applyOverrides in class CustomizationCommandLineBase

Parameters:

overmap - override key-value map

Returns:

map for key/values not recognized

printUsage

public void printUsage()

Description copied from class: CustomizationCommandLineBase

Print usage information.

Specified by:

printUsage in class CustomizationCommandLineBase