org.jomc.tools.modlet.ToolsModelProvider Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jomc-tools Show documentation
Show all versions of jomc-tools Show documentation
Object management and configuration tools.
/*
* Copyright (C) Christian Schulte , 2005-206
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* o Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* $JOMC: ToolsModelProvider.java 5043 2015-05-27 07:03:39Z schulte $
*
*/
package org.jomc.tools.modlet;
import java.lang.reflect.Field;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;
import java.util.Set;
import java.util.logging.Level;
import javax.xml.bind.JAXBElement;
import javax.xml.namespace.QName;
import org.jomc.model.Dependencies;
import org.jomc.model.Implementation;
import org.jomc.model.InheritanceModel;
import org.jomc.model.JavaTypeName;
import org.jomc.model.Messages;
import org.jomc.model.ModelObjectException;
import org.jomc.model.Module;
import org.jomc.model.Modules;
import org.jomc.model.Properties;
import org.jomc.model.Specification;
import org.jomc.model.Specifications;
import org.jomc.model.modlet.ModelHelper;
import org.jomc.modlet.Model;
import org.jomc.modlet.ModelContext;
import org.jomc.modlet.ModelException;
import org.jomc.modlet.ModelProvider;
import org.jomc.tools.model.ObjectFactory;
import org.jomc.tools.model.SourceFileType;
import org.jomc.tools.model.SourceFilesType;
import org.jomc.tools.model.SourceSectionType;
import org.jomc.tools.model.SourceSectionsType;
import static org.jomc.tools.modlet.ToolsModletConstants.ANNOTATIONS_SECTION_NAME;
import static org.jomc.tools.modlet.ToolsModletConstants.CONSTRUCTORS_HEAD_TEMPLATE;
import static org.jomc.tools.modlet.ToolsModletConstants.CONSTRUCTORS_SECTION_NAME;
import static org.jomc.tools.modlet.ToolsModletConstants.CONSTRUCTORS_TAIL_TEMPLATE;
import static org.jomc.tools.modlet.ToolsModletConstants.DEFAULT_CONSTRUCTOR_SECTION_NAME;
import static org.jomc.tools.modlet.ToolsModletConstants.DEFAULT_CONSTRUCTOR_TEMPLATE;
import static org.jomc.tools.modlet.ToolsModletConstants.DEPENDENCIES_SECTION_NAME;
import static org.jomc.tools.modlet.ToolsModletConstants.DEPENDENCIES_TEMPLATE;
import static org.jomc.tools.modlet.ToolsModletConstants.DOCUMENTATION_SECTION_NAME;
import static org.jomc.tools.modlet.ToolsModletConstants.IMPLEMENTATION_ANNOTATIONS_TEMPLATE;
import static org.jomc.tools.modlet.ToolsModletConstants.IMPLEMENTATION_DOCUMENTATION_TEMPLATE;
import static org.jomc.tools.modlet.ToolsModletConstants.IMPLEMENTATION_LICENSE_TEMPLATE;
import static org.jomc.tools.modlet.ToolsModletConstants.IMPLEMENTATION_TEMPLATE;
import static org.jomc.tools.modlet.ToolsModletConstants.LICENSE_SECTION_NAME;
import static org.jomc.tools.modlet.ToolsModletConstants.MESSAGES_SECTION_NAME;
import static org.jomc.tools.modlet.ToolsModletConstants.MESSAGES_TEMPLATE;
import static org.jomc.tools.modlet.ToolsModletConstants.PROPERTIES_SECTION_NAME;
import static org.jomc.tools.modlet.ToolsModletConstants.PROPERTIES_TEMPLATE;
import static org.jomc.tools.modlet.ToolsModletConstants.SPECIFICATION_ANNOTATIONS_TEMPLATE;
import static org.jomc.tools.modlet.ToolsModletConstants.SPECIFICATION_DOCUMENTATION_TEMPLATE;
import static org.jomc.tools.modlet.ToolsModletConstants.SPECIFICATION_LICENSE_TEMPLATE;
import static org.jomc.tools.modlet.ToolsModletConstants.SPECIFICATION_TEMPLATE;
/**
* Object management and configuration tools {@code ModelProvider} implementation.
*
* @author Christian Schulte
* @version $JOMC: ToolsModelProvider.java 5043 2015-05-27 07:03:39Z schulte $
* @see ModelContext#findModel(java.lang.String)
* @since 1.2
*/
public class ToolsModelProvider implements ModelProvider
{
/**
* Constant for the qualified name of {@code source-files} elements.
*/
private static final QName SOURCE_FILES_QNAME = new ObjectFactory().createSourceFiles( null ).getName();
/**
* Constant for the name of the model context attribute backing property {@code enabled}.
*
* @see #findModel(org.jomc.modlet.ModelContext, org.jomc.modlet.Model)
* @see ModelContext#getAttribute(java.lang.String)
*/
public static final String ENABLED_ATTRIBUTE_NAME = "org.jomc.tools.modlet.ToolsModelProvider.enabledAttribute";
/**
* Constant for the name of the system property controlling property {@code defaultEnabled}.
*
* @see #isDefaultEnabled()
*/
private static final String DEFAULT_ENABLED_PROPERTY_NAME =
"org.jomc.tools.modlet.ToolsModelProvider.defaultEnabled";
/**
* Default value of the flag indicating the provider is enabled by default.
*
* @see #isDefaultEnabled()
*/
private static final Boolean DEFAULT_ENABLED = Boolean.TRUE;
/**
* Flag indicating the provider is enabled by default.
*/
private static volatile Boolean defaultEnabled;
/**
* Flag indicating the provider is enabled.
*/
private Boolean enabled;
/**
* Constant for the name of the model context attribute backing property
* {@code modelObjectClasspathResolutionEnabled}.
*
* @see #findModel(org.jomc.modlet.ModelContext, org.jomc.modlet.Model)
* @see ModelContext#getAttribute(java.lang.String)
*/
public static final String MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED_ATTRIBUTE_NAME =
"org.jomc.tools.modlet.ToolsModelProvider.modelObjectClasspathResolutionEnabledAttribute";
/**
* Constant for the name of the system property controlling property
* {@code defaultModelObjectClasspathResolutionEnabled}.
*
* @see #isDefaultModelObjectClasspathResolutionEnabled()
*/
private static final String DEFAULT_MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED_PROPERTY_NAME =
"org.jomc.tools.modlet.ToolsModelProvider.defaultModelObjectClasspathResolutionEnabled";
/**
* Default value of the flag indicating model object class path resolution is enabled by default.
*
* @see #isDefaultModelObjectClasspathResolutionEnabled()
*/
private static final Boolean DEFAULT_MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED = Boolean.TRUE;
/**
* Flag indicating model object class path resolution is enabled by default.
*/
private static volatile Boolean defaultModelObjectClasspathResolutionEnabled;
/**
* Flag indicating model object class path resolution is enabled.
*/
private Boolean modelObjectClasspathResolutionEnabled;
/**
* Constant for the name of the model context attribute backing property {@code headComment}.
*
* @see #findModel(org.jomc.modlet.ModelContext, org.jomc.modlet.Model)
* @see ModelContext#getAttribute(java.lang.String)
* @since 1.6
*/
public static final String HEAD_COMMENT_ATTRIBUTE_NAME =
"org.jomc.tools.modlet.ToolsModelProvider.headCommentAttribute";
/**
* Constant for the name of the system property controlling property {@code defaultHeadComment}.
*
* @see #getDefaultHeadComment()
* @since 1.6
*/
private static final String DEFAULT_HEAD_COMMENT_PROPERTY_NAME =
"org.jomc.tools.modlet.ToolsModelProvider.defaultHeadComment";
/**
* Default head comment the provider is providing by default.
*
* @see #getDefaultHeadComment()
* @since 1.6
*/
private static final String DEFAULT_HEAD_COMMENT = "//";
/**
* Head comment the provider is providing by default.
*
* @since 1.6
*/
private static volatile String defaultHeadComment;
/**
* Head comment the provider is providing.
*
* @since 1.6
*/
private String headComment;
/**
* Constant for the name of the model context attribute backing property {@code tailComment}.
*
* @see #findModel(org.jomc.modlet.ModelContext, org.jomc.modlet.Model)
* @see ModelContext#getAttribute(java.lang.String)
* @since 1.6
*/
public static final String TAIL_COMMENT_ATTRIBUTE_NAME =
"org.jomc.tools.modlet.ToolsModelProvider.tailCommentAttribute";
/**
* Constant for the name of the system property controlling property {@code defaultTailComment}.
*
* @see #getDefaultTailComment()
* @since 1.6
*/
private static final String DEFAULT_TAIL_COMMENT_PROPERTY_NAME =
"org.jomc.tools.modlet.ToolsModelProvider.defaultTailComment";
/**
* Default tail comment the provider is providing by default.
*
* @see #getDefaultTailComment()
* @since 1.6
*/
private static final String DEFAULT_TAIL_COMMENT = null;
/**
* Tail comment the provider is providing by default.
*
* @since 1.6
*/
private static volatile String defaultTailComment;
/**
* Tail comment the provider is providing.
*
* @since 1.6
*/
private String tailComment;
/**
* Creates a new {@code ToolsModelProvider} instance.
*/
public ToolsModelProvider()
{
super();
}
/**
* Gets a flag indicating the provider is enabled by default.
*
* The default enabled flag is controlled by system property
* {@code org.jomc.tools.modlet.ToolsModelProvider.defaultEnabled} holding a value indicating the provider is
* enabled by default. If that property is not set, the {@code true} default is returned.
*
*
* @return {@code true}, if the provider is enabled by default; {@code false}, if the provider is disabled by
* default.
*
* @see #setDefaultEnabled(java.lang.Boolean)
*/
public static boolean isDefaultEnabled()
{
if ( defaultEnabled == null )
{
defaultEnabled = Boolean.valueOf( System.getProperty( DEFAULT_ENABLED_PROPERTY_NAME,
Boolean.toString( DEFAULT_ENABLED ) ) );
}
return defaultEnabled;
}
/**
* Sets the flag indicating the provider is enabled by default.
*
* @param value The new value of the flag indicating the provider is enabled by default or {@code null}.
*
* @see #isDefaultEnabled()
*/
public static void setDefaultEnabled( final Boolean value )
{
defaultEnabled = value;
}
/**
* Gets a flag indicating the provider is enabled.
*
* @return {@code true}, if the provider is enabled; {@code false}, if the provider is disabled.
*
* @see #isDefaultEnabled()
* @see #setEnabled(java.lang.Boolean)
*/
public final boolean isEnabled()
{
if ( this.enabled == null )
{
this.enabled = isDefaultEnabled();
}
return this.enabled;
}
/**
* Sets the flag indicating the provider is enabled.
*
* @param value The new value of the flag indicating the provider is enabled or {@code null}.
*
* @see #isEnabled()
*/
public final void setEnabled( final Boolean value )
{
this.enabled = value;
}
/**
* Gets a flag indicating model object class path resolution is enabled by default.
*
* The model object class path resolution default enabled flag is controlled by system property
* {@code org.jomc.tools.modlet.ToolsModelProvider.defaultModelObjectClasspathResolutionEnabled} holding a value
* indicating model object class path resolution is enabled by default. If that property is not set, the
* {@code true} default is returned.
*
*
* @return {@code true}, if model object class path resolution is enabled by default; {@code false}, if model object
* class path resolution is disabled by default.
*
* @see #setDefaultModelObjectClasspathResolutionEnabled(java.lang.Boolean)
*/
public static boolean isDefaultModelObjectClasspathResolutionEnabled()
{
if ( defaultModelObjectClasspathResolutionEnabled == null )
{
defaultModelObjectClasspathResolutionEnabled = Boolean.valueOf( System.getProperty(
DEFAULT_MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED_PROPERTY_NAME,
Boolean.toString( DEFAULT_MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED ) ) );
}
return defaultModelObjectClasspathResolutionEnabled;
}
/**
* Sets the flag indicating model object class path resolution is enabled by default.
*
* @param value The new value of the flag indicating model object class path resolution is enabled by default or
* {@code null}.
*
* @see #isDefaultModelObjectClasspathResolutionEnabled()
*/
public static void setDefaultModelObjectClasspathResolutionEnabled( final Boolean value )
{
defaultModelObjectClasspathResolutionEnabled = value;
}
/**
* Gets a flag indicating model object class path resolution is enabled.
*
* @return {@code true}, if model object class path resolution is enabled; {@code false}, if model object class path
* resolution is disabled.
*
* @see #isDefaultModelObjectClasspathResolutionEnabled()
* @see #setModelObjectClasspathResolutionEnabled(java.lang.Boolean)
*/
public final boolean isModelObjectClasspathResolutionEnabled()
{
if ( this.modelObjectClasspathResolutionEnabled == null )
{
this.modelObjectClasspathResolutionEnabled = isDefaultModelObjectClasspathResolutionEnabled();
}
return this.modelObjectClasspathResolutionEnabled;
}
/**
* Sets the flag indicating model object class path resolution is is enabled.
*
* @param value The new value of the flag indicating model object class path resolution is enabled or {@code null}.
*
* @see #isModelObjectClasspathResolutionEnabled()
*/
public final void setModelObjectClasspathResolutionEnabled( final Boolean value )
{
this.modelObjectClasspathResolutionEnabled = value;
}
/**
* Gets the head comment the provider is providing by default.
*
* The default head comment is controlled by system property
* {@code org.jomc.tools.modlet.ToolsModelProvider.defaultHeadComment} holding the head comment the provider is
* providing by default. If that property is not set, the {@code //} default is returned.
*
*
* @return The head comment the provider is providing by default or {@code null}.
*
* @see #setDefaultHeadComment(java.lang.String)
* @since 1.6
*/
public static String getDefaultHeadComment()
{
if ( defaultHeadComment == null )
{
defaultHeadComment = System.getProperty( DEFAULT_HEAD_COMMENT_PROPERTY_NAME, DEFAULT_HEAD_COMMENT );
}
return defaultHeadComment;
}
/**
* Sets the head comment the provider is providing by default.
*
* @param value The new head comment the provider is providing by default or {@code null}.
*
* @see #getDefaultHeadComment()
* @since 1.6
*/
public static void setDefaultHeadComment( final String value )
{
defaultHeadComment = value;
}
/**
* Gets the head comment the provider is providing.
*
* @return The head comment the provider is providing or {@code null}.
*
* @see #getDefaultHeadComment()
* @see #setDefaultHeadComment(java.lang.String)
* @since 1.6
*/
public final String getHeadComment()
{
if ( this.headComment == null )
{
this.headComment = getDefaultHeadComment();
}
return this.headComment;
}
/**
* Sets the head comment the provider is providing.
*
* @param value The new head comment the provider is providing or {@code null}.
*
* @see #getHeadComment()
* @since 1.6
*/
public final void setHeadComment( final String value )
{
this.headComment = value;
}
/**
* Gets the tail comment the provider is providing by default.
*
* The default tail comment is controlled by system property
* {@code org.jomc.tools.modlet.ToolsModelProvider.defaultTailComment} holding the tail comment the provider is
* providing by default. If that property is not set, the {@code null} default is returned.
*
*
* @return The tail comment the provider is providing by default or {@code null}.
*
* @see #setDefaultTailComment(java.lang.String)
* @since 1.6
*/
public static String getDefaultTailComment()
{
if ( defaultTailComment == null )
{
defaultTailComment = System.getProperty( DEFAULT_TAIL_COMMENT_PROPERTY_NAME, DEFAULT_TAIL_COMMENT );
}
return defaultTailComment;
}
/**
* Sets the tail comment the provider is providing by default.
*
* @param value The new tail comment the provider is providing by default or {@code null}.
*
* @see #getDefaultTailComment()
* @since 1.6
*/
public static void setDefaultTailComment( final String value )
{
defaultTailComment = value;
}
/**
* Gets the tail comment the provider is providing.
*
* @return The tail comment the provider is providing or {@code null}.
*
* @see #getDefaultTailComment()
* @see #setDefaultTailComment(java.lang.String)
* @since 1.6
*/
public final String getTailComment()
{
if ( this.tailComment == null )
{
this.tailComment = getDefaultTailComment();
}
return this.tailComment;
}
/**
* Sets the tail comment the provider is providing.
*
* @param value The new tail comment the provider is providing or {@code null}.
*
* @see #getTailComment()
* @since 1.6
*/
public final void setTailComment( final String value )
{
this.tailComment = value;
}
/**
* {@inheritDoc}
*
* @see #isEnabled()
* @see #isModelObjectClasspathResolutionEnabled()
* @see #getHeadComment()
* @see #getTailComment()
* @see #ENABLED_ATTRIBUTE_NAME
* @see #MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED_ATTRIBUTE_NAME
* @see #HEAD_COMMENT_ATTRIBUTE_NAME
* @see #TAIL_COMMENT_ATTRIBUTE_NAME
*/
public Model findModel( final ModelContext context, final Model model ) throws ModelException
{
if ( context == null )
{
throw new NullPointerException( "context" );
}
if ( model == null )
{
throw new NullPointerException( "model" );
}
Model provided = null;
boolean contextEnabled = this.isEnabled();
if ( DEFAULT_ENABLED == contextEnabled && context.getAttribute( ENABLED_ATTRIBUTE_NAME ) instanceof Boolean )
{
contextEnabled = (Boolean) context.getAttribute( ENABLED_ATTRIBUTE_NAME );
}
boolean contextModelObjectClasspathResolutionEnabled = this.isModelObjectClasspathResolutionEnabled();
if ( contextModelObjectClasspathResolutionEnabled == DEFAULT_MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED
&& context.getAttribute( MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED_ATTRIBUTE_NAME ) instanceof Boolean )
{
contextModelObjectClasspathResolutionEnabled =
(Boolean) context.getAttribute( MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED_ATTRIBUTE_NAME );
}
if ( contextEnabled )
{
provided = model.clone();
final Modules modules = ModelHelper.getModules( provided );
if ( modules != null )
{
Module classpathModule = null;
if ( contextModelObjectClasspathResolutionEnabled )
{
classpathModule = modules.getClasspathModule( Modules.getDefaultClasspathModuleName(),
context.getClassLoader() );
if ( classpathModule != null
&& modules.getModule( Modules.getDefaultClasspathModuleName() ) == null )
{
modules.getModule().add( classpathModule );
}
else
{
classpathModule = null;
}
}
if ( modules.getSpecifications() != null )
{
for ( int i = 0, s0 = modules.getSpecifications().getSpecification().size(); i < s0; i++ )
{
final Specification specification = modules.getSpecifications().getSpecification().get( i );
final SourceFileType sourceFileType = specification.getAnyObject( SourceFileType.class );
final SourceFilesType sourceFilesType = specification.getAnyObject( SourceFilesType.class );
if ( sourceFileType == null && specification.isClassDeclaration() )
{
final SourceFilesType defaultSourceFiles =
this.getDefaultSourceFilesType( context, modules, specification );
if ( sourceFilesType != null )
{
this.overwriteSourceFiles( sourceFilesType, defaultSourceFiles, true );
}
else
{
specification.getAny().add(
new ObjectFactory().createSourceFiles( defaultSourceFiles ) );
}
}
}
}
if ( modules.getImplementations() != null )
{
final Map userSourceFiles =
new HashMap(
modules.getImplementations().getImplementation().size() );
InheritanceModel imodel = new InheritanceModel( modules );
for ( int i = 0, s0 = modules.getImplementations().getImplementation().size(); i < s0; i++ )
{
final Implementation implementation = modules.getImplementations().getImplementation().get( i );
final SourceFileType sourceFileType = implementation.getAnyObject( SourceFileType.class );
final SourceFilesType sourceFilesType = implementation.getAnyObject( SourceFilesType.class );
if ( sourceFileType == null )
{
if ( sourceFilesType != null )
{
userSourceFiles.put( implementation, sourceFilesType );
}
else if ( implementation.isClassDeclaration() )
{
final SourceFilesType defaultSourceFiles =
this.getDefaultSourceFilesType( context, modules, implementation );
boolean finalAncestor = false;
final Set>> sourceFilesNodes =
imodel.getJaxbElementNodes( implementation.getIdentifier(), SOURCE_FILES_QNAME );
for ( final InheritanceModel.Node> sourceFilesNode : sourceFilesNodes )
{
if ( sourceFilesNode.getModelObject().getValue() instanceof SourceFilesType )
{
final SourceFilesType ancestorSourceFiles =
(SourceFilesType) sourceFilesNode.getModelObject().getValue();
this.overwriteSourceFiles( defaultSourceFiles, ancestorSourceFiles, false );
if ( ancestorSourceFiles.isFinal() )
{
finalAncestor = true;
}
}
}
if ( !finalAncestor )
{
implementation.getAny().add(
new ObjectFactory().createSourceFiles( defaultSourceFiles ) );
}
}
}
}
for ( final Map.Entry e : userSourceFiles.entrySet() )
{
this.overwriteSourceFiles( e.getValue(), this.getDefaultSourceFilesType(
context, modules, e.getKey() ), true );
}
imodel = new InheritanceModel( modules );
for ( int i = 0, s0 = modules.getImplementations().getImplementation().size(); i < s0; i++ )
{
final Implementation implementation = modules.getImplementations().getImplementation().get( i );
final SourceFilesType sourceFilesType = implementation.getAnyObject( SourceFilesType.class );
if ( sourceFilesType != null && !userSourceFiles.containsKey( implementation ) )
{
boolean override = false;
final Set>> sourceFilesNodes =
imodel.getJaxbElementNodes( implementation.getIdentifier(), SOURCE_FILES_QNAME );
for ( final InheritanceModel.Node> e : sourceFilesNodes )
{
if ( !e.getOverriddenNodes().isEmpty() )
{
override = true;
break;
}
}
if ( override )
{
sourceFilesType.setOverride( override );
}
}
}
}
if ( classpathModule != null )
{
modules.getModule().remove( classpathModule );
}
}
}
else if ( context.isLoggable( Level.FINER ) )
{
context.log( Level.FINER, getMessage( "disabled", this.getClass().getSimpleName(),
model.getIdentifier() ), null );
}
return provided;
}
/**
* Gets the default source code file location for a given specification.
*
* If the specification provides a Java type name, this method returns a Java source code file location based on
* that Java type name.
*
*
* @param context The context to get the default location with.
* @param modules The model to get the default location with.
* @param specification The specification to get the default location for.
*
* @return The default location for {@code specification} or {@code null}.
*
* @throws NullPointerException if {@code context}, {@code modules} or {@code specification} is {@code null}.
*
* @see #getDefaultSourceFilesType(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Specification)
* @see SourceFileType#getLocation()
* @see Specification#getJavaTypeName()
* @since 1.6
*/
protected String getDefaultSourceFileLocation( final ModelContext context, final Modules modules,
final Specification specification )
{
if ( context == null )
{
throw new NullPointerException( "context" );
}
if ( modules == null )
{
throw new NullPointerException( "modules" );
}
if ( specification == null )
{
throw new NullPointerException( "specification" );
}
String location = null;
try
{
if ( specification.getJavaTypeName() != null )
{
location = specification.getJavaTypeName().getQualifiedName().replace( '.', '/' ) + ".java";
}
}
catch ( final ModelObjectException e )
{
context.log( Level.WARNING, getMessage( e ), null );
}
return location;
}
/**
* Gets the default source code file location for a given implementation.
*
* If the implementation provides a Java type name, this method returns a Java source code file location based on
* that Java type name.
*
*
* @param context The context to get the default location with.
* @param modules The model to get the default location with.
* @param implementation The implementation to get the default location for.
*
* @return The default location for {@code implementation} or {@code null}.
*
* @throws NullPointerException if {@code context}, {@code modules} or {@code implementation} is {@code null}.
*
* @see #getDefaultSourceFilesType(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Implementation)
* @see SourceFileType#getLocation()
* @see Implementation#getJavaTypeName()
* @since 1.6
*/
protected String getDefaultSourceFileLocation( final ModelContext context, final Modules modules,
final Implementation implementation )
{
if ( context == null )
{
throw new NullPointerException( "context" );
}
if ( modules == null )
{
throw new NullPointerException( "modules" );
}
if ( implementation == null )
{
throw new NullPointerException( "implementation" );
}
String location = null;
try
{
if ( implementation.getJavaTypeName() != null )
{
location = implementation.getJavaTypeName().getQualifiedName().replace( '.', '/' ) + ".java";
}
}
catch ( final ModelObjectException e )
{
context.log( Level.WARNING, getMessage( e ), null );
}
return location;
}
/**
* Gets the default source section name for a given specification.
*
* If the specification provides a Java type name, this method returns a section name based on that Java type
* name.
*
*
* @param context The context to get the default section name with.
* @param modules The model to get the default section name with.
* @param specification The specification to get the default section name for.
*
* @return The default source section name for {@code specification} or {@code null}.
*
* @throws NullPointerException if {@code context}, {@code modules} or {@code specification} is {@code null}.
*
* @see #getDefaultSourceFilesType(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Specification)
* @see SourceSectionType#getName()
* @see Specification#getJavaTypeName()
* @since 1.6
*/
protected String getDefaultSourceSectionName( final ModelContext context, final Modules modules,
final Specification specification )
{
if ( context == null )
{
throw new NullPointerException( "context" );
}
if ( modules == null )
{
throw new NullPointerException( "modules" );
}
if ( specification == null )
{
throw new NullPointerException( "specification" );
}
String sectionName = null;
try
{
final JavaTypeName javaTypeName = specification.getJavaTypeName();
if ( javaTypeName != null )
{
sectionName = javaTypeName.getName( false );
}
}
catch ( final ModelObjectException e )
{
context.log( Level.WARNING, getMessage( e ), null );
}
return sectionName;
}
/**
* Gets the default source section name for a given implementation.
*
* If the implementation provides a Java type name, this method returns a section name based that Java type
* name.
*
*
* @param context The context to get the default section name with.
* @param modules The model to get the default section name with.
* @param implementation The implementation to get the default section name for.
*
* @return The default source section name for {@code implementation} or {@code null}.
*
* @throws NullPointerException if {@code context}, {@code modules} or {@code implementation} is {@code null}.
*
* @see #getDefaultSourceFilesType(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Implementation)
* @see SourceSectionType#getName()
* @see Implementation#getJavaTypeName()
* @since 1.6
*/
protected String getDefaultSourceSectionName( final ModelContext context, final Modules modules,
final Implementation implementation )
{
if ( context == null )
{
throw new NullPointerException( "context" );
}
if ( modules == null )
{
throw new NullPointerException( "modules" );
}
if ( implementation == null )
{
throw new NullPointerException( "implementation" );
}
String sectionName = null;
try
{
final JavaTypeName javaTypeName = implementation.getJavaTypeName();
if ( javaTypeName != null )
{
sectionName = javaTypeName.getName( false );
}
}
catch ( final ModelObjectException e )
{
context.log( Level.WARNING, getMessage( e ), null );
}
return sectionName;
}
/**
* Creates a new default source files model for a given specification.
*
* @param context The context to create a new default source files model with.
* @param modules The model to create a new default source files model with.
* @param specification The specification to create a new default source files model for.
*
* @return A new default source files model for {@code specification}.
*
* @throws NullPointerException if {@code context}, {@code modules} or {@code specification} is {@code null}.
*
* @see #getDefaultSourceFileLocation(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Specification)
* @see #getDefaultSourceSectionName(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Specification)
* @since 1.6
*/
protected SourceFilesType getDefaultSourceFilesType( final ModelContext context, final Modules modules,
final Specification specification )
{
if ( context == null )
{
throw new NullPointerException( "context" );
}
if ( modules == null )
{
throw new NullPointerException( "modules" );
}
if ( specification == null )
{
throw new NullPointerException( "specification" );
}
String contextHeadComment = this.getHeadComment();
if ( ( DEFAULT_HEAD_COMMENT != null
? DEFAULT_HEAD_COMMENT.equals( contextHeadComment )
: contextHeadComment == null )
&& context.getAttribute( HEAD_COMMENT_ATTRIBUTE_NAME ) instanceof String )
{
contextHeadComment = (String) context.getAttribute( HEAD_COMMENT_ATTRIBUTE_NAME );
}
if ( contextHeadComment != null && contextHeadComment.length() == 0 )
{
contextHeadComment = null;
}
String contextTailComment = this.getTailComment();
if ( ( DEFAULT_TAIL_COMMENT != null
? DEFAULT_TAIL_COMMENT.equals( contextTailComment )
: contextTailComment == null )
&& context.getAttribute( TAIL_COMMENT_ATTRIBUTE_NAME ) instanceof String )
{
contextTailComment = (String) context.getAttribute( TAIL_COMMENT_ATTRIBUTE_NAME );
}
if ( contextTailComment != null && contextTailComment.length() == 0 )
{
contextTailComment = null;
}
final Set uniqueSectionNames = new HashSet( 16 );
final Set sectionNames = new HashSet( 16 );
sectionNames.add( LICENSE_SECTION_NAME );
sectionNames.add( ANNOTATIONS_SECTION_NAME );
sectionNames.add( DOCUMENTATION_SECTION_NAME );
final SourceFilesType sourceFilesType = new SourceFilesType();
final SourceFileType sourceFileType = new SourceFileType();
sourceFilesType.getSourceFile().add( sourceFileType );
sourceFileType.setIdentifier( "Default" );
sourceFileType.setLocation( this.getDefaultSourceFileLocation( context, modules, specification ) );
sourceFileType.setTemplate( SPECIFICATION_TEMPLATE );
sourceFileType.setHeadComment( contextHeadComment );
sourceFileType.setTailComment( contextTailComment );
sourceFileType.setSourceSections( new SourceSectionsType() );
SourceSectionType s = new SourceSectionType();
s.setName( LICENSE_SECTION_NAME );
s.setHeadTemplate( SPECIFICATION_LICENSE_TEMPLATE );
s.setOptional( true );
sourceFileType.getSourceSections().getSourceSection().add( s );
s = new SourceSectionType();
s.setName( ANNOTATIONS_SECTION_NAME );
s.setHeadTemplate( SPECIFICATION_ANNOTATIONS_TEMPLATE );
sourceFileType.getSourceSections().getSourceSection().add( s );
s = new SourceSectionType();
s.setName( DOCUMENTATION_SECTION_NAME );
s.setHeadTemplate( SPECIFICATION_DOCUMENTATION_TEMPLATE );
s.setOptional( true );
sourceFileType.getSourceSections().getSourceSection().add( s );
final String sectionName = this.getDefaultSourceSectionName( context, modules, specification );
if ( sectionName != null )
{
if ( sectionNames.add( sectionName ) )
{
s = new SourceSectionType();
s.setName( sectionName );
s.setIndentationLevel( 1 );
s.setEditable( true );
sourceFileType.getSourceSections().getSourceSection().add( s );
}
else if ( uniqueSectionNames.add( sectionName ) )
{
final Module module = modules.getModuleOfSpecification( specification.getIdentifier() );
context.log( Level.WARNING, getMessage( "specificationSectionNameUniqueness",
specification.getIdentifier(),
module.getName(),
sourceFileType.getIdentifier(),
sectionName ),
null );
}
}
return sourceFilesType;
}
/**
* Creates a new default source files model for a given implementation.
*
* @param context The context to create a new default source files model with.
* @param modules The model to create a new default source files model with.
* @param implementation The implementation to create a new default source files model for.
*
* @return A new default source files model for {@code implementation}.
*
* @throws NullPointerException if {@code context}, {@code modules} or {@code implementation} is {@code null}.
*
* @see #getDefaultSourceFileLocation(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Implementation)
* @see #getDefaultSourceSectionName(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Implementation)
* @since 1.6
*/
protected SourceFilesType getDefaultSourceFilesType( final ModelContext context, final Modules modules,
final Implementation implementation )
{
if ( context == null )
{
throw new NullPointerException( "context" );
}
if ( modules == null )
{
throw new NullPointerException( "modules" );
}
if ( implementation == null )
{
throw new NullPointerException( "implementation" );
}
String contextHeadComment = this.getHeadComment();
if ( ( DEFAULT_HEAD_COMMENT != null
? DEFAULT_HEAD_COMMENT.equals( contextHeadComment )
: contextHeadComment == null )
&& context.getAttribute( HEAD_COMMENT_ATTRIBUTE_NAME ) instanceof String )
{
contextHeadComment = (String) context.getAttribute( HEAD_COMMENT_ATTRIBUTE_NAME );
}
if ( contextHeadComment != null && contextHeadComment.length() == 0 )
{
contextHeadComment = null;
}
String contextTailComment = this.getTailComment();
if ( ( DEFAULT_TAIL_COMMENT != null
? DEFAULT_TAIL_COMMENT.equals( contextTailComment )
: contextTailComment == null )
&& context.getAttribute( TAIL_COMMENT_ATTRIBUTE_NAME ) instanceof String )
{
contextTailComment = (String) context.getAttribute( TAIL_COMMENT_ATTRIBUTE_NAME );
}
if ( contextTailComment != null && contextTailComment.length() == 0 )
{
contextTailComment = null;
}
final Set uniqueSectionNames = new HashSet( 16 );
final ArrayList sectionNames = new ArrayList( 16 );
sectionNames.add( LICENSE_SECTION_NAME );
sectionNames.add( ANNOTATIONS_SECTION_NAME );
sectionNames.add( DOCUMENTATION_SECTION_NAME );
sectionNames.add( CONSTRUCTORS_SECTION_NAME );
sectionNames.add( DEFAULT_CONSTRUCTOR_SECTION_NAME );
sectionNames.add( DEPENDENCIES_SECTION_NAME );
sectionNames.add( PROPERTIES_SECTION_NAME );
sectionNames.add( MESSAGES_SECTION_NAME );
final SourceFilesType sourceFilesType = new SourceFilesType();
final SourceFileType sourceFileType = new SourceFileType();
sourceFilesType.getSourceFile().add( sourceFileType );
final Specifications specifications = modules.getSpecifications( implementation.getIdentifier() );
final Dependencies dependencies = modules.getDependencies( implementation.getIdentifier() );
final Messages messages = modules.getMessages( implementation.getIdentifier() );
final Properties properties = modules.getProperties( implementation.getIdentifier() );
sourceFileType.setIdentifier( "Default" );
sourceFileType.setLocation( this.getDefaultSourceFileLocation( context, modules, implementation ) );
sourceFileType.setTemplate( IMPLEMENTATION_TEMPLATE );
sourceFileType.setHeadComment( contextHeadComment );
sourceFileType.setTailComment( contextTailComment );
sourceFileType.setSourceSections( new SourceSectionsType() );
SourceSectionType s = new SourceSectionType();
s.setName( LICENSE_SECTION_NAME );
s.setHeadTemplate( IMPLEMENTATION_LICENSE_TEMPLATE );
s.setOptional( true );
sourceFileType.getSourceSections().getSourceSection().add( s );
s = new SourceSectionType();
s.setName( ANNOTATIONS_SECTION_NAME );
s.setHeadTemplate( IMPLEMENTATION_ANNOTATIONS_TEMPLATE );
sourceFileType.getSourceSections().getSourceSection().add( s );
s = new SourceSectionType();
s.setName( DOCUMENTATION_SECTION_NAME );
s.setHeadTemplate( IMPLEMENTATION_DOCUMENTATION_TEMPLATE );
s.setOptional( true );
sourceFileType.getSourceSections().getSourceSection().add( s );
if ( specifications != null )
{
sectionNames.ensureCapacity( sectionNames.size() + specifications.getSpecification().size() );
for ( final Specification specification : specifications.getSpecification() )
{
final String sectionName = this.getDefaultSourceSectionName( context, modules, specification );
if ( sectionName != null )
{
if ( !sectionNames.contains( sectionName ) )
{
sectionNames.add( sectionName );
s = new SourceSectionType();
s.setName( sectionName );
s.setIndentationLevel( 1 );
s.setEditable( true );
sourceFileType.getSourceSections().getSourceSection().add( s );
}
else if ( uniqueSectionNames.add( sectionName ) )
{
final Module module = modules.getModuleOfImplementation( implementation.getIdentifier() );
context.log( Level.WARNING, getMessage( "implementationSectionNameUniqueness",
implementation.getIdentifier(),
module.getName(),
sourceFileType.getIdentifier(),
sectionName ),
null );
}
}
}
}
final String sectionName = this.getDefaultSourceSectionName( context, modules, implementation );
if ( sectionName != null )
{
if ( !sectionNames.contains( sectionName ) )
{
sectionNames.add( sectionName );
s = new SourceSectionType();
s.setName( sectionName );
s.setIndentationLevel( 1 );
s.setEditable( true );
sourceFileType.getSourceSections().getSourceSection().add( s );
}
else if ( uniqueSectionNames.add( sectionName ) )
{
final Module module = modules.getModuleOfImplementation( implementation.getIdentifier() );
context.log( Level.WARNING, getMessage( "implementationSectionNameUniqueness",
implementation.getIdentifier(),
module.getName(),
sourceFileType.getIdentifier(),
sectionName ),
null );
}
}
s = new SourceSectionType();
s.setName( CONSTRUCTORS_SECTION_NAME );
s.setIndentationLevel( 1 );
s.setHeadTemplate( CONSTRUCTORS_HEAD_TEMPLATE );
s.setTailTemplate( CONSTRUCTORS_TAIL_TEMPLATE );
s.setOptional( specifications == null || ( specifications.getSpecification().isEmpty()
&& specifications.getReference().isEmpty() ) );
s.setSourceSections( new SourceSectionsType() );
sourceFileType.getSourceSections().getSourceSection().add( s );
final SourceSectionType defaultCtor = new SourceSectionType();
defaultCtor.setName( DEFAULT_CONSTRUCTOR_SECTION_NAME );
defaultCtor.setIndentationLevel( 2 );
defaultCtor.setHeadTemplate( DEFAULT_CONSTRUCTOR_TEMPLATE );
defaultCtor.setEditable( true );
s.getSourceSections().getSourceSection().add( defaultCtor );
s = new SourceSectionType();
s.setName( DEPENDENCIES_SECTION_NAME );
s.setIndentationLevel( 1 );
s.setHeadTemplate( DEPENDENCIES_TEMPLATE );
s.setOptional( dependencies == null || dependencies.getDependency().isEmpty() );
sourceFileType.getSourceSections().getSourceSection().add( s );
s = new SourceSectionType();
s.setName( PROPERTIES_SECTION_NAME );
s.setIndentationLevel( 1 );
s.setHeadTemplate( PROPERTIES_TEMPLATE );
s.setOptional( properties == null || properties.getProperty().isEmpty() );
sourceFileType.getSourceSections().getSourceSection().add( s );
s = new SourceSectionType();
s.setName( MESSAGES_SECTION_NAME );
s.setIndentationLevel( 1 );
s.setHeadTemplate( MESSAGES_TEMPLATE );
s.setOptional( messages == null || messages.getMessage().isEmpty() );
sourceFileType.getSourceSections().getSourceSection().add( s );
return sourceFilesType;
}
/**
* Overwrites a list of source code files with another list of source code files.
*
* @param targetSourceFiles The list to overwrite.
* @param sourceSourceFiles The list to overwrite with.
* @param preserveExisting {@code true}, to preserve existing attributes of source code files and sections;
* {@code false}, to overwrite existing attributes of source code files and sections.
*
* @throws NullPointerException if {@code targetSourceFiles} or {@code sourceSourceFiles} is {@code null}.
*/
private void overwriteSourceFiles( final SourceFilesType targetSourceFiles, final SourceFilesType sourceSourceFiles,
final boolean preserveExisting )
{
if ( targetSourceFiles == null )
{
throw new NullPointerException( "targetSourceFiles" );
}
if ( sourceSourceFiles == null )
{
throw new NullPointerException( "sourceSourceFiles" );
}
try
{
for ( final SourceFileType s : sourceSourceFiles.getSourceFile() )
{
final SourceFileType targetSourceFile = targetSourceFiles.getSourceFile( s.getIdentifier() );
if ( targetSourceFile != null )
{
this.overwriteSourceFile( targetSourceFile, s, preserveExisting );
}
}
}
catch ( final NoSuchFieldException e )
{
throw new AssertionError( e );
}
}
/**
* Overwrites a source code file with another source code file.
*
* @param targetSourceFile The source code file to overwrite.
* @param sourceSourceFile The source code file to overwrite with.
* @param preserveExisting {@code true}, to preserve existing attributes of the given source code file and sections;
* {@code false}, to overwrite existing attributes of the given source code file and sections.
*
* @throws NullPointerException if {@code targetSourceFile} or {@code sourceSourceFile} is {@code null}.
*/
private void overwriteSourceFile( final SourceFileType targetSourceFile, final SourceFileType sourceSourceFile,
final boolean preserveExisting )
throws NoSuchFieldException
{
if ( targetSourceFile == null )
{
throw new NullPointerException( "targetSourceFile" );
}
if ( sourceSourceFile == null )
{
throw new NullPointerException( "sourceSourceFile" );
}
if ( !preserveExisting )
{
targetSourceFile.setIdentifier( sourceSourceFile.getIdentifier() );
targetSourceFile.setLocation( sourceSourceFile.getLocation() );
targetSourceFile.setTemplate( sourceSourceFile.getTemplate() );
targetSourceFile.setHeadComment( sourceSourceFile.getHeadComment() );
targetSourceFile.setTailComment( sourceSourceFile.getTailComment() );
if ( isFieldSet( sourceSourceFile, "_final" ) )
{
targetSourceFile.setFinal( sourceSourceFile.isFinal() );
}
if ( isFieldSet( sourceSourceFile, "modelVersion" ) )
{
targetSourceFile.setModelVersion( sourceSourceFile.getModelVersion() );
}
if ( isFieldSet( sourceSourceFile, "override" ) )
{
targetSourceFile.setOverride( sourceSourceFile.isOverride() );
}
}
if ( sourceSourceFile.getSourceSections() != null )
{
if ( targetSourceFile.getSourceSections() == null )
{
targetSourceFile.setSourceSections( new SourceSectionsType() );
}
this.overwriteSourceSections( targetSourceFile.getSourceSections(), sourceSourceFile.getSourceSections(),
preserveExisting );
}
}
/**
* Overwrites source code file sections with other source code file sections.
*
* @param targetSourceSections The source code file sections to overwrite.
* @param sourceSourceSections The source code file sections to overwrite with.
* @param preserveExisting {@code true}, to preserve existing attributes of the given source code file sections;
* {@code false}, to overwrite existing attributes of the given source code file sections.
*
* @throws NullPointerException if {@code targetSourceSections} or {@code sourceSourceSections} is {@code null}.
*/
private void overwriteSourceSections( final SourceSectionsType targetSourceSections,
final SourceSectionsType sourceSourceSections,
final boolean preserveExisting ) throws NoSuchFieldException
{
if ( targetSourceSections == null )
{
throw new NullPointerException( "targetSourceSections" );
}
if ( sourceSourceSections == null )
{
throw new NullPointerException( "sourceSourceSections" );
}
for ( final SourceSectionType sourceSection : sourceSourceSections.getSourceSection() )
{
SourceSectionType targetSection = null;
for ( final SourceSectionType t : targetSourceSections.getSourceSection() )
{
if ( sourceSection.getName().equals( t.getName() ) )
{
targetSection = t;
break;
}
}
if ( targetSection != null )
{
if ( !preserveExisting )
{
targetSection.setName( sourceSection.getName() );
targetSection.setHeadTemplate( sourceSection.getHeadTemplate() );
targetSection.setTailTemplate( sourceSection.getTailTemplate() );
if ( isFieldSet( sourceSection, "editable" ) )
{
targetSection.setEditable( sourceSection.isEditable() );
}
if ( isFieldSet( sourceSection, "indentationLevel" ) )
{
targetSection.setIndentationLevel( sourceSection.getIndentationLevel() );
}
if ( isFieldSet( sourceSection, "modelVersion" ) )
{
targetSection.setModelVersion( sourceSection.getModelVersion() );
}
if ( isFieldSet( sourceSection, "optional" ) )
{
targetSection.setOptional( sourceSection.isOptional() );
}
}
}
else
{
targetSection = sourceSection.clone();
targetSourceSections.getSourceSection().add( targetSection );
}
if ( sourceSection.getSourceSections() != null )
{
if ( targetSection.getSourceSections() == null )
{
targetSection.setSourceSections( new SourceSectionsType() );
}
this.overwriteSourceSections( targetSection.getSourceSections(), sourceSection.getSourceSections(),
preserveExisting );
}
}
}
private static boolean isFieldSet( final Object object, final String fieldName ) throws NoSuchFieldException
{
final Field field = getField( object.getClass(), fieldName );
if ( field == null )
{
throw new NoSuchFieldException( fieldName );
}
final boolean accessible = field.isAccessible();
try
{
field.setAccessible( true );
return field.get( object ) != null;
}
catch ( final IllegalAccessException e )
{
throw new AssertionError( e );
}
finally
{
field.setAccessible( accessible );
}
}
private static Field getField( final Class clazz, final String name )
{
if ( clazz != null )
{
try
{
return clazz.getDeclaredField( name );
}
catch ( final NoSuchFieldException e )
{
return getField( clazz.getSuperclass(), name );
}
}
return null;
}
private static String getMessage( final Throwable t )
{
return t != null
? t.getMessage() != null && t.getMessage().trim().length() > 0
? t.getMessage()
: getMessage( t.getCause() )
: null;
}
private static String getMessage( final String key, final Object... args )
{
return MessageFormat.format( ResourceBundle.getBundle(
ToolsModelProvider.class.getName().replace( '.', '/' ), Locale.getDefault() ).getString( key ), args );
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy