com.sun.tools.xjc.addon.xew.config

Class AbstractConfigurablePlugin

java.lang.Object

com.sun.tools.xjc.Plugin

org.jvnet.jaxb2_commons.plugin.AbstractPlugin

org.jvnet.jaxb2_commons.plugin.AbstractParameterizablePlugin

com.sun.tools.xjc.addon.xew.config.AbstractConfigurablePlugin

Direct Known Subclasses:

XmlElementWrapperPlugin

public abstract class AbstractConfigurablePlugin
extends org.jvnet.jaxb2_commons.plugin.AbstractParameterizablePlugin

Plugin base class that only contains code for plugin initalization and logging.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMONS_LOGGING_LOG_LEVEL_PROPERTY_KEY
protected GlobalConfiguration	globalConfiguration

Fields inherited from class org.jvnet.jaxb2_commons.plugin.AbstractPlugin

logger

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurablePlugin()

Method Summary

Modifier and Type	Method and Description
protected static <T extends CommonConfiguration> T	applyConfigurationFromCustomizations(CommonConfiguration configuration, com.sun.tools.xjc.model.CCustomizations customizations, boolean cloneClassConfiguration) Clone given configuration and apply settings from global/class/field JAXB customization.
Collection<QName>	getCustomizationElementNames()
String	getOptionName()
String	getUsage()
void	onActivated(com.sun.tools.xjc.Options opts)
int	parseArgument(com.sun.tools.xjc.Options opts, String[] args, int i) Parse and apply plugin configuration options.
boolean	run(com.sun.tools.xjc.outline.Outline outline, com.sun.tools.xjc.Options opt, ErrorHandler errorHandler) Implements exception handling.
protected abstract void	runInternal(com.sun.tools.xjc.outline.Outline outline) Actual work is done in this method.
String	toString()
protected void	writeSummary(String s)

Methods inherited from class org.jvnet.jaxb2_commons.plugin.AbstractPlugin

afterRun, beforeRun, getCustomizationURIs, init, isCustomizationTagName, run

Methods inherited from class com.sun.tools.xjc.Plugin

postProcessModel

Methods inherited from class java.lang.Object

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

Field Detail

globalConfiguration

protected GlobalConfiguration globalConfiguration

COMMONS_LOGGING_LOG_LEVEL_PROPERTY_KEY

public static final String COMMONS_LOGGING_LOG_LEVEL_PROPERTY_KEY

See Also:

Constant Field Values

Constructor Detail

AbstractConfigurablePlugin

public AbstractConfigurablePlugin()

Method Detail

getOptionName

public String getOptionName()

Specified by:

getOptionName in class com.sun.tools.xjc.Plugin

getUsage

public String getUsage()

Specified by:

getUsage in class com.sun.tools.xjc.Plugin

getCustomizationElementNames

public Collection<QName> getCustomizationElementNames()

Overrides:

getCustomizationElementNames in class org.jvnet.jaxb2_commons.plugin.AbstractPlugin

writeSummary

protected final void writeSummary(String s)

onActivated

public void onActivated(com.sun.tools.xjc.Options opts)

Overrides:

onActivated in class org.jvnet.jaxb2_commons.plugin.AbstractPlugin

parseArgument

public int parseArgument(com.sun.tools.xjc.Options opts,
                         String[] args,
                         int i)
                  throws com.sun.tools.xjc.BadCommandLineException

Parse and apply plugin configuration options.

Overrides:

parseArgument in class org.jvnet.jaxb2_commons.plugin.AbstractParameterizablePlugin

Returns:

number of consumed argument options

Throws:

com.sun.tools.xjc.BadCommandLineException

applyConfigurationFromCustomizations

protected static <T extends CommonConfiguration> T applyConfigurationFromCustomizations(CommonConfiguration configuration,
                                                                                        com.sun.tools.xjc.model.CCustomizations customizations,
                                                                                        boolean cloneClassConfiguration)
                                                                                 throws IOException,
                                                                                        ClassNotFoundException

Clone given configuration and apply settings from global/class/field JAXB customization.

Throws:

IOException

ClassNotFoundException

run

public boolean run(com.sun.tools.xjc.outline.Outline outline,
                   com.sun.tools.xjc.Options opt,
                   ErrorHandler errorHandler)
            throws SAXException

Implements exception handling.

Overrides:

run in class org.jvnet.jaxb2_commons.plugin.AbstractPlugin

Throws:

SAXException

runInternal

protected abstract void runInternal(com.sun.tools.xjc.outline.Outline outline)
                             throws ClassNotFoundException,
                                    IOException

Actual work is done in this method.

Throws:

ClassNotFoundException

IOException

toString

public String toString()

Overrides:

toString in class Object