org.jomc.tools
Class JomcTool

java.lang.Object
  org.jomc.tools.JomcTool

Direct Known Subclasses:

ClassFileProcessor, ResourceFileProcessor, SourceFileProcessor

public abstract class JomcTool
extends Object

Base tool class.

Version:

$Id: JomcTool.java 2179 2010-06-28 17:49:49Z schulte2005 $

Author:

Christian Schulte

Nested Class Summary

Modifier and Type	Class and Description
static class	JomcTool.Listener Listener interface.

Constructor and Description

JomcTool()
Creates a new JomcTool instance.

JomcTool(JomcTool tool)
Creates a new JomcTool instance taking a JomcTool instance to initialize the new instance with.

Method Summary

Modifier and Type	Method and Description
static Level	getDefaultLogLevel() Gets the default log level events are logged at.
static String	getDefaultTemplateProfile() Gets the default template profile.
String	getDisplayLanguage(String language) Gets the display language of a given language code.
String	getIndentation() Gets the indentation string of the instance.
String	getIndentation(int level) Gets an indentation string for a given indentation level.
String	getInputEncoding() Gets the encoding to use for reading files.
String	getJavaClasspathLocation(org.jomc.model.Implementation implementation) Gets the Java class path location of an implementation.
String	getJavaClasspathLocation(org.jomc.model.Specification specification) Gets the Java class path location of a specification.
String	getJavadocComment(org.jomc.model.Text text, int indentationLevel, String suffix) Formats a text to a Javadoc comment.
String	getJavaGetterMethodName(org.jomc.model.Dependency dependency) Gets the name of a Java accessor method of a given dependency.
String	getJavaGetterMethodName(org.jomc.model.Message message) Gets the name of a Java accessor method of a given message.
String	getJavaGetterMethodName(org.jomc.model.Property property) Gets the name of a Java accessor method of a given property.
List<String>	getJavaInterfaceNames(org.jomc.model.Implementation implementation, boolean qualified) Gets all Java interfaces an implementation implements.
String	getJavaModifierName(org.jomc.model.Implementation implementation, org.jomc.model.Dependency dependency) Gets the name of a Java modifier of a dependency of a given implementation.
String	getJavaModifierName(org.jomc.model.Implementation implementation, org.jomc.model.Message message) Gets the name of a Java modifier of a message of a given implementation.
String	getJavaModifierName(org.jomc.model.Implementation implementation, org.jomc.model.Property property) Gets the name of a Java modifier for a given property of a given implementation.
String	getJavaPackageName(org.jomc.model.Implementation implementation) Gets the Java package name of an implementation.
String	getJavaPackageName(org.jomc.model.Specification specification) Gets the Java package name of a specification.
String	getJavaPackageName(org.jomc.model.SpecificationReference reference) Gets the Java package name of a specification reference.
String	getJavaString(String str) Formats a string to a Java string with unicode escapes.
String	getJavaTypeName(org.jomc.model.Argument argument) Gets the Java type name of an argument.
String	getJavaTypeName(org.jomc.model.Dependency dependency) Gets the name of a Java type of a given dependency.
String	getJavaTypeName(org.jomc.model.Implementation implementation, boolean qualified) Gets the Java type name of an implementation.
String	getJavaTypeName(org.jomc.model.Property property, boolean boxify) Gets the Java type name of a property.
String	getJavaTypeName(org.jomc.model.Specification specification, boolean qualified) Gets the Java type name of a specification.
String	getJavaTypeName(org.jomc.model.SpecificationReference reference, boolean qualified) Gets the name of a Java type of a given specification reference.
String	getLineSeparator() Gets the line separator of the instance.
List<JomcTool.Listener>	getListeners() Gets the list of registered listeners.
Level	getLogLevel() Gets the log level of the instance.
String	getLongDate(Calendar calendar) Formats a calendar instance to a string.
String	getLongDateTime(Calendar calendar) Formats a calendar instance to a string.
String	getLongTime(Calendar calendar) Formats a calendar instance to a string.
org.jomc.modlet.Model	getModel() Gets the model of the instance.
org.jomc.model.Modules	getModules() Gets the modules of the instance.
String	getOutputEncoding() Gets the encoding to use for writing files.
String	getShortDate(Calendar calendar) Formats a calendar instance to a string.
String	getShortDateTime(Calendar calendar) Formats a calendar instance to a string.
String	getShortTime(Calendar calendar) Formats a calendar instance to a string.
String	getTemplateEncoding() Gets the encoding to use for reading templates.
String	getTemplateProfile() Gets the template profile of the instance.
org.apache.velocity.VelocityContext	getVelocityContext() Gets the velocity context used for merging templates.
org.apache.velocity.app.VelocityEngine	getVelocityEngine() Gets the VelocityEngine of the instance.
org.apache.velocity.Template	getVelocityTemplate(String templateName) Gets a velocity template for a given name.
String	getYears(Calendar start, Calendar end) Gets a string describing the range of years for given calendars.
boolean	isJavaDefaultPackage(org.jomc.model.Implementation implementation) Gets a flag indicating if the class of a given implementation is located in the Java default package.
boolean	isJavaDefaultPackage(org.jomc.model.Specification specification) Gets a flag indicating if the class of a given specification is located in the Java default package.
boolean	isJavaPrimitiveType(org.jomc.model.Property property) Gets a flag indicating if the type of a given property is a Java primitive.
boolean	isLoggable(Level level) Checks if a message at a given level is provided to the listeners of the instance.
protected void	log(Level level, String message, Throwable throwable) Notifies registered listeners.
static void	setDefaultLogLevel(Level value) Sets the default log level events are logged at.
static void	setDefaultTemplateProfile(String value) Sets the default template profile.
void	setIndentation(String value) Sets the indentation string of the instance.
void	setInputEncoding(String value) Sets the encoding to use for reading files.
void	setLineSeparator(String value) Sets the line separator of the instance.
void	setLogLevel(Level value) Sets the log level of the instance.
void	setModel(org.jomc.modlet.Model value) Sets the model of the instance.
void	setOutputEncoding(String value) Sets the encoding to use for writing files.
void	setTemplateEncoding(String value) Sets the encoding to use for reading templates.
void	setTemplateProfile(String value) Sets the template profile of the instance.
void	setVelocityEngine(org.apache.velocity.app.VelocityEngine value) Sets the VelocityEngine of the instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

JomcTool

public JomcTool()

Creates a new JomcTool instance.

JomcTool

public JomcTool(JomcTool tool)
         throws IOException

Creates a new JomcTool instance taking a JomcTool instance to initialize the new instance with.

Parameters:

tool - The instance to initialize the new instance with.

Throws:

NullPointerException - if tool is null.

IOException - if copying tool fails.

Method Detail

getListeners

public List<JomcTool.Listener> getListeners()

Gets the list of registered listeners.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the object. This is why there is no set method for the listeners property.

Returns:

The list of registered listeners.

See Also:

log(java.util.logging.Level, java.lang.String, java.lang.Throwable)

getDefaultLogLevel

public static Level getDefaultLogLevel()

Gets the default log level events are logged at.

The default log level is controlled by system property org.jomc.tools.JomcTool.defaultLogLevel holding the log level to log events at by default. If that property is not set, the WARNING default is returned.

Returns:

The log level events are logged at by default.

See Also:

getLogLevel(), Level.parse(java.lang.String)

setDefaultLogLevel

public static void setDefaultLogLevel(Level value)

Sets the default log level events are logged at.

Parameters:

value - The new default level events are logged at or null.

See Also:

getDefaultLogLevel()

getLogLevel

public final Level getLogLevel()

Gets the log level of the instance.

Returns:

The log level of the instance.

See Also:

getDefaultLogLevel(), setLogLevel(java.util.logging.Level), isLoggable(java.util.logging.Level)

setLogLevel

public final void setLogLevel(Level value)

Sets the log level of the instance.

Parameters:

value - The new log level of the instance or null.

See Also:

getLogLevel(), isLoggable(java.util.logging.Level)

isLoggable

public boolean isLoggable(Level level)

Checks if a message at a given level is provided to the listeners of the instance.

Parameters:

level - The level to test.

Returns:

true if messages at level are provided to the listeners of the instance; false if messages at level are not provided to the listeners of the instance.

Throws:

NullPointerException - if level is null.

See Also:

getLogLevel(), setLogLevel(java.util.logging.Level), log(java.util.logging.Level, java.lang.String, java.lang.Throwable)

getJavaPackageName

public String getJavaPackageName(org.jomc.model.Specification specification)

Gets the Java package name of a specification.

Parameters:

specification - The specification to get the Java package name of.

Returns:

The Java package name of specification or null.

Throws:

NullPointerException - if specification is null.

getJavaTypeName

public String getJavaTypeName(org.jomc.model.Specification specification,
                              boolean qualified)

Gets the Java type name of a specification.

Parameters:

specification - The specification to get the Java type name of.

qualified - true to return the fully qualified type name (with package name prepended); false to return the short type name (without package name prepended).

Returns:

The Java type name of specification or null.

Throws:

NullPointerException - if specification is null.

getJavaClasspathLocation

public String getJavaClasspathLocation(org.jomc.model.Specification specification)

Gets the Java class path location of a specification.

Parameters:

specification - The specification to return the Java class path location of.

Returns:

The Java class path location of specification or null.

Throws:

NullPointerException - if specification is null.

getJavaPackageName

public String getJavaPackageName(org.jomc.model.SpecificationReference reference)

Gets the Java package name of a specification reference.

Parameters:

reference - The specification reference to get the Java package name of.

Returns:

The Java package name of reference or null.

Throws:

NullPointerException - if reference is null.

getJavaTypeName

public String getJavaTypeName(org.jomc.model.SpecificationReference reference,
                              boolean qualified)

Gets the name of a Java type of a given specification reference.

Parameters:

reference - The specification reference to get a Java type name of.

qualified - true to return the fully qualified type name (with package name prepended); false to return the short type name (without package name prepended).

Returns:

The Java type name of reference or null.

Throws:

NullPointerException - if reference is null.

getJavaPackageName

public String getJavaPackageName(org.jomc.model.Implementation implementation)

Gets the Java package name of an implementation.

Parameters:

implementation - The implementation to get the Java package name of.

Returns:

The Java package name of implementation or null.

Throws:

NullPointerException - if implementation is null.

getJavaTypeName

public String getJavaTypeName(org.jomc.model.Implementation implementation,
                              boolean qualified)

Gets the Java type name of an implementation.

Parameters:

implementation - The implementation to get the Java type name of.

qualified - true to return the fully qualified type name (with package name prepended); false to return the short type name (without package name prepended).

Returns:

The Java type name of implementation or null.

Throws:

NullPointerException - if implementation is null.

getJavaClasspathLocation

public String getJavaClasspathLocation(org.jomc.model.Implementation implementation)

Gets the Java class path location of an implementation.

Parameters:

implementation - The implementation to return the Java class path location of.

Returns:

The Java class path location of implementation or null.

Throws:

NullPointerException - if implementation is null.

getJavaInterfaceNames

public List<String> getJavaInterfaceNames(org.jomc.model.Implementation implementation,
                                          boolean qualified)

Gets all Java interfaces an implementation implements.

Parameters:

implementation - The implementation to get all implemented Java interfaces of.

qualified - true to return the fully qualified type names (with package name prepended); false to return the short type names (without package name prepended).

Returns:

Unmodifiable list contaning all Java interfaces implemented by implementation.

Throws:

NullPointerException - if implementation is null.

getJavaTypeName

public String getJavaTypeName(org.jomc.model.Argument argument)

Gets the Java type name of an argument.

Parameters:

argument - The argument to get the Java type name of.

Returns:

The Java type name of argument.

Throws:

NullPointerException - if argument is null.

getJavaTypeName

public String getJavaTypeName(org.jomc.model.Property property,
                              boolean boxify)

Gets the Java type name of a property.

Parameters:

property - The property to get the Java type name of.

boxify - true to return the name of the Java wrapper class when the type is a Java primitive type; false to return the exact binary name (unboxed name) of the Java type.

Returns:

The Java type name of property.

Throws:

NullPointerException - if property is null.

isJavaPrimitiveType

public boolean isJavaPrimitiveType(org.jomc.model.Property property)

Gets a flag indicating if the type of a given property is a Java primitive.

Parameters:

property - The property to query.

Returns:

true if the type of property is a Java primitive; false if not.

Throws:

NullPointerException - if property is null.

getJavaGetterMethodName

public String getJavaGetterMethodName(org.jomc.model.Property property)

Gets the name of a Java accessor method of a given property.

Parameters:

property - The property to get a Java accessor method name of.

Returns:

The Java accessor method name of property.

Throws:

NullPointerException - if property is null.

getJavaTypeName

public String getJavaTypeName(org.jomc.model.Dependency dependency)

Gets the name of a Java type of a given dependency.

Parameters:

dependency - The dependency to get a dependency Java type name of.

Returns:

The Java type name of dependency or null.

Throws:

NullPointerException - if dependency is null.

getJavaGetterMethodName

public String getJavaGetterMethodName(org.jomc.model.Dependency dependency)

Gets the name of a Java accessor method of a given dependency.

Parameters:

dependency - The dependency to get a Java accessor method name of.

Returns:

The Java accessor method name of dependency.

Throws:

NullPointerException - if dependency is null.

getJavaGetterMethodName

public String getJavaGetterMethodName(org.jomc.model.Message message)

Gets the name of a Java accessor method of a given message.

Parameters:

message - The message to get a Java accessor method name of.

Returns:

The Java accessor method name of message.

Throws:

NullPointerException - if message is null.

getJavaModifierName

public String getJavaModifierName(org.jomc.model.Implementation implementation,
                                  org.jomc.model.Dependency dependency)

Gets the name of a Java modifier of a dependency of a given implementation.

Parameters:

implementation - The implementation to get a dependency Java modifier name of.

dependency - The dependency to get a Java modifier name of.

Returns:

The Java modifier name of dependency of implementation.

Throws:

NullPointerException - if implementation or dependency is null.

getJavaModifierName

public String getJavaModifierName(org.jomc.model.Implementation implementation,
                                  org.jomc.model.Message message)

Gets the name of a Java modifier of a message of a given implementation.

Parameters:

implementation - The implementation to get a message Java modifier name of.

message - The message to get a Java modifier name of.

Returns:

The Java modifier name of message of implementation.

Throws:

NullPointerException - if implementation or message is null.

getJavaModifierName

public String getJavaModifierName(org.jomc.model.Implementation implementation,
                                  org.jomc.model.Property property)

Gets the name of a Java modifier for a given property of a given implementation.

Parameters:

implementation - The implementation declaring property.

property - The property to get a Java modifier name for.

Returns:

The Java modifier name for property of implementation.

Throws:

NullPointerException - if implementation or property is null.

getJavadocComment

public String getJavadocComment(org.jomc.model.Text text,
                                int indentationLevel,
                                String suffix)

Formats a text to a Javadoc comment.

Parameters:

text - The text to format to a Javadoc comment.

indentationLevel - The indentation level of the comment.

suffix - The text to append to any line breaks.

Returns:

text formatted as a Javadoc comment.

Throws:

NullPointerException - if text or suffix is null.

IllegalArgumentException - if indentationLevel is negative.

getJavaString

public String getJavaString(String str)

Formats a string to a Java string with unicode escapes.

Parameters:

str - The string to format to a Java string or null.

Returns:

str formatted as a Java string or null.

isJavaDefaultPackage

public boolean isJavaDefaultPackage(org.jomc.model.Specification specification)

Gets a flag indicating if the class of a given specification is located in the Java default package.

Parameters:

specification - The specification to test.

Returns:

true if the class of specification is located in the Java default package; false if not.

Throws:

NullPointerException - if specification is null.

isJavaDefaultPackage

public boolean isJavaDefaultPackage(org.jomc.model.Implementation implementation)

Gets a flag indicating if the class of a given implementation is located in the Java default package.

Parameters:

implementation - The implementation to test.

Returns:

true if the class of implementation is located in the Java default package; false if not.

Throws:

NullPointerException - if implementation is null.

getDisplayLanguage

public String getDisplayLanguage(String language)

Gets the display language of a given language code.

Parameters:

language - The language code to get the display language of.

Returns:

The display language of language.

Throws:

NullPointerException - if language is null.

getShortDate

public String getShortDate(Calendar calendar)

Formats a calendar instance to a string.

Parameters:

calendar - The calendar to format.

Returns:

Date of calendar formatted using a short format style pattern.

Throws:

NullPointerException - if calendar is null.

See Also:

DateFormat.SHORT

getLongDate

public String getLongDate(Calendar calendar)

Formats a calendar instance to a string.

Parameters:

calendar - The calendar to format.

Returns:

Date of calendar formatted using a long format style pattern.

Throws:

NullPointerException - if calendar is null.

See Also:

DateFormat.LONG

getShortTime

public String getShortTime(Calendar calendar)

Formats a calendar instance to a string.

Parameters:

calendar - The calendar to format.

Returns:

Time of calendar formatted using a short format style pattern.

Throws:

NullPointerException - if calendar is null.

See Also:

DateFormat.SHORT

getLongTime

public String getLongTime(Calendar calendar)

Formats a calendar instance to a string.

Parameters:

calendar - The calendar to format.

Returns:

Time of calendar formatted using a long format style pattern.

Throws:

NullPointerException - if calendar is null.

See Also:

DateFormat.LONG

getShortDateTime

public String getShortDateTime(Calendar calendar)

Formats a calendar instance to a string.

Parameters:

calendar - The calendar to format.

Returns:

Date and time of calendar formatted using a short format style pattern.

Throws:

NullPointerException - if calendar is null.

See Also:

DateFormat.SHORT

getLongDateTime

public String getLongDateTime(Calendar calendar)

Formats a calendar instance to a string.

Parameters:

calendar - The calendar to format.

Returns:

Date and time of calendar formatted using a long format style pattern.

Throws:

NullPointerException - if calendar is null.

See Also:

DateFormat.LONG

getYears

public String getYears(Calendar start,
                       Calendar end)

Gets a string describing the range of years for given calendars.

Parameters:

start - The start of the range.

end - The end of the range.

Returns:

Formatted range of the years of start and end.

Throws:

NullPointerException - if start or end is null.

getModel

public org.jomc.modlet.Model getModel()

Gets the model of the instance.

Returns:

The model of the instance.

See Also:

getModules(), setModel(org.jomc.modlet.Model)

setModel

public void setModel(org.jomc.modlet.Model value)

Sets the model of the instance.

Parameters:

value - The new model of the instance.

See Also:

getModel()

getModules

public org.jomc.model.Modules getModules()

Gets the modules of the instance.

Returns:

The modules of the instance.

See Also:

getModel(), setModel(org.jomc.modlet.Model)

getVelocityEngine

public org.apache.velocity.app.VelocityEngine getVelocityEngine()
                                                         throws IOException

Gets the VelocityEngine of the instance.

Returns:

The VelocityEngine of the instance.

Throws:

IOException - if initializing a new velocity engine fails.

See Also:

setVelocityEngine(org.apache.velocity.app.VelocityEngine)

setVelocityEngine

public void setVelocityEngine(org.apache.velocity.app.VelocityEngine value)

Sets the VelocityEngine of the instance.

Parameters:

value - The new VelocityEngine of the instance.

See Also:

getVelocityEngine()

getVelocityContext

public org.apache.velocity.VelocityContext getVelocityContext()

Gets the velocity context used for merging templates.

Returns:

The velocity context used for merging templates.

getTemplateEncoding

public final String getTemplateEncoding()

Gets the encoding to use for reading templates.

Returns:

The encoding to use for reading templates.

See Also:

setTemplateEncoding(java.lang.String)

setTemplateEncoding

public final void setTemplateEncoding(String value)

Sets the encoding to use for reading templates.

Parameters:

value - The new encoding to use for reading templates or null.

See Also:

getTemplateEncoding()

getInputEncoding

public final String getInputEncoding()

Gets the encoding to use for reading files.

Returns:

The encoding to use for reading files.

See Also:

setInputEncoding(java.lang.String)

setInputEncoding

public final void setInputEncoding(String value)

Sets the encoding to use for reading files.

Parameters:

value - The new encoding to use for reading files or null.

See Also:

getInputEncoding()

getOutputEncoding

public final String getOutputEncoding()

Gets the encoding to use for writing files.

Returns:

The encoding to use for writing files.

See Also:

setOutputEncoding(java.lang.String)

setOutputEncoding

public final void setOutputEncoding(String value)

Sets the encoding to use for writing files.

Parameters:

value - The encoding to use for writing files or null.

See Also:

getOutputEncoding()

getDefaultTemplateProfile

public static String getDefaultTemplateProfile()

Gets the default template profile.

The default template profile is controlled by system property org.jomc.tools.JomcTool.defaultTemplateProfile holding the name of the template profile to use by default. If that property is not set, the jomc-java default is returned.

Returns:

The default template profile.

See Also:

setDefaultTemplateProfile(java.lang.String)

setDefaultTemplateProfile

public static void setDefaultTemplateProfile(String value)

Sets the default template profile.

Parameters:

value - The new default template profile or null.

See Also:

getDefaultTemplateProfile()

getTemplateProfile

public final String getTemplateProfile()

Gets the template profile of the instance.

Returns:

The template profile of the instance.

See Also:

getDefaultTemplateProfile(), setTemplateProfile(java.lang.String)

setTemplateProfile

public final void setTemplateProfile(String value)

Sets the template profile of the instance.

Parameters:

value - The new template profile of the instance or null.

See Also:

getTemplateProfile()

getIndentation

public final String getIndentation()

Gets the indentation string of the instance.

Returns:

The indentation string of the instance.

getIndentation

public final String getIndentation(int level)

Gets an indentation string for a given indentation level.

Parameters:

level - The indentation level to get an indentation string for.

Returns:

The indentation string for level.

Throws:

IllegalArgumentException - if level is negative.

See Also:

getIndentation()

setIndentation

public final void setIndentation(String value)

Sets the indentation string of the instance.

Parameters:

value - The new indentation string of the instance or null.

See Also:

getIndentation()

getLineSeparator

public final String getLineSeparator()

Gets the line separator of the instance.

Returns:

The line separator of the instance.

setLineSeparator

public final void setLineSeparator(String value)

Sets the line separator of the instance.

Parameters:

value - The new line separator of the instance or null.

See Also:

getLineSeparator()

getVelocityTemplate

public org.apache.velocity.Template getVelocityTemplate(String templateName)
                                                 throws IOException

Gets a velocity template for a given name.

This method returns the template corresponding to the profile of the instance. If that template is not found, the template of the default profile is returned so that only templates differing from the default templates need to be provided when exchanging templates.

Parameters:

templateName - The name of the template to get.

Returns:

The template matching templateName.

Throws:

NullPointerException - if templateName is null.

IOException - if getting the template fails.

See Also:

getTemplateProfile(), getTemplateEncoding()

log

protected void log(Level level,
                   String message,
                   Throwable throwable)

Notifies registered listeners.

Parameters:

level - The level of the event.

message - The message of the event or null.

throwable - The throwable of the event or null.

Throws:

NullPointerException - if level is null.

See Also:

getListeners()