org.jomc.tools
Class SourceFileProcessor

Package class diagram package SourceFileProcessor
java.lang.Object
  extended by org.jomc.tools.JomcTool
      extended by org.jomc.tools.SourceFileProcessor

public class SourceFileProcessor
extends JomcTool

Processes source code files.

Use Cases:

Version:
$JOMC: SourceFileProcessor.java 4352 2012-03-01 11:19:48Z schulte2005 $
Author:
Christian Schulte

Nested Class Summary
 class SourceFileProcessor.SourceFileEditor
          Extension to SectionEditor adding support for editing source code files.
 
Nested classes/interfaces inherited from class org.jomc.tools.JomcTool
JomcTool.Listener
 
Constructor Summary
SourceFileProcessor()
          Creates a new SourceFileProcessor instance.
SourceFileProcessor(SourceFileProcessor tool)
          Creates a new SourceFileProcessor instance taking a SourceFileProcessor instance to initialize the instance with.
 
Method Summary
 SourceFileProcessor.SourceFileEditor getSourceFileEditor()
          Gets the source file editor of the instance.
 SourceFileProcessor.SourceFileEditor getSourceFileEditor(Implementation implementation)
          Deprecated. As of JOMC 1.2, please use method getSourceFileEditor(). This method will be removed in version 2.0.
 SourceFileProcessor.SourceFileEditor getSourceFileEditor(Specification specification)
          Deprecated. As of JOMC 1.2, please use method getSourceFileEditor(). This method will be removed in version 2.0.
 SourceFilesType getSourceFilesType()
          Deprecated. As of JOMC 1.2, please add source file models to Specifications and Implementations directly. This method will be removed in version 2.0.
 SourceFilesType getSourceFilesType(Implementation implementation)
          Gets the source files model of an implementation of the modules of the instance.
 SourceFilesType getSourceFilesType(Specification specification)
          Gets the source files model of a specification of the modules of the instance.
 SourceFileType getSourceFileType(Implementation implementation)
          Deprecated. As of JOMC 1.2, please use method getSourceFilesType(org.jomc.model.Implementation). This method will be removed in version 2.0.
 SourceFileType getSourceFileType(Specification specification)
          Deprecated. As of JOMC 1.2, please use method getSourceFilesType(org.jomc.model.Specification). This method will be removed in version 2.0.
 void manageSourceFiles(File sourcesDirectory)
          Manages the source files of the modules of the instance.
 void manageSourceFiles(Implementation implementation, File sourcesDirectory)
          Manages the source files of a given implementation of the modules of the instance.
 void manageSourceFiles(Module module, File sourcesDirectory)
          Manages the source files of a given module of the modules of the instance.
 void manageSourceFiles(Specification specification, File sourcesDirectory)
          Manages the source files of a given specification of the modules of the instance.
 void setSourceFileEditor(SourceFileProcessor.SourceFileEditor value)
          Sets the source file editor of the instance.
 
Methods inherited from class org.jomc.tools.JomcTool
getBooleanString, getCsvString, getDefaultLogLevel, getDefaultTemplateProfile, getDisplayLanguage, getHtmlString, getImplementedJavaTypeNames, getIndentation, getIndentation, getInputEncoding, getIsoDate, getIsoDateTime, getIsoTime, getJavaClasspathLocation, getJavaClasspathLocation, getJavadocComment, getJavadocComment, getJavaGetterMethodName, getJavaGetterMethodName, getJavaGetterMethodName, getJavaIdentifier, getJavaInterfaceNames, getJavaMethodParameterName, getJavaMethodParameterName, getJavaMethodParameterName, getJavaMethodParameterName, getJavaModifierName, getJavaModifierName, getJavaModifierName, getJavaPackageName, getJavaPackageName, getJavaPackageName, getJavaScriptString, getJavaSetterMethodName, getJavaSetterMethodName, getJavaSetterMethodName, getJavaString, getJavaTypeName, getJavaTypeName, getJavaTypeName, getJavaTypeName, getJavaTypeName, getJavaTypeName, getLineSeparator, getListeners, getLocale, getLogLevel, getLongDate, getLongDateTime, getLongTime, getMediumDate, getMediumDateTime, getMediumTime, getModel, getModules, getOutputEncoding, getShortDate, getShortDateTime, getShortTime, getSqlString, getTemplateEncoding, getTemplateLocation, getTemplateParameters, getTemplateProfile, getVelocityContext, getVelocityEngine, getVelocityTemplate, getXmlString, getYears, isJavaDefaultPackage, isJavaDefaultPackage, isJavaPrimitiveType, isLoggable, log, setDefaultLogLevel, setDefaultTemplateProfile, setIndentation, setInputEncoding, setLineSeparator, setLocale, setLogLevel, setModel, setOutputEncoding, setTemplateEncoding, setTemplateLocation, setTemplateProfile, setVelocityEngine
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SourceFileProcessor

public SourceFileProcessor()
Creates a new SourceFileProcessor instance.


SourceFileProcessor

public SourceFileProcessor(SourceFileProcessor tool)
                    throws IOException
Creates a new SourceFileProcessor instance taking a SourceFileProcessor instance to initialize the 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

getSourceFilesType

@Deprecated
public SourceFilesType getSourceFilesType()
Deprecated. As of JOMC 1.2, please add source file models to Specifications and Implementations directly. This method will be removed in version 2.0.

Gets the source files model of the instance.

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

Returns:
The source files model of the instance.
See Also:
getSourceFileType(org.jomc.model.Specification), getSourceFileType(org.jomc.model.Implementation)

getSourceFileType

@Deprecated
public SourceFileType getSourceFileType(Specification specification)
Deprecated. As of JOMC 1.2, please use method getSourceFilesType(org.jomc.model.Specification). This method will be removed in version 2.0.

Gets the model of a specification source file of the modules of the instance.

Parameters:
specification - The specification to get a source file model for.
Returns:
The source file model for specification. As of JOMC 1.2, this method returns null if no source file model is found.
Throws:
NullPointerException - if specification is null.

getSourceFilesType

public SourceFilesType getSourceFilesType(Specification specification)
Gets the source files model of a specification of the modules of the instance.

Parameters:
specification - The specification to get a source files model for.
Returns:
The source files model for specification or null, if no source files model is found.
Throws:
NullPointerException - if specification is null.
Since:
1.2

getSourceFileType

@Deprecated
public SourceFileType getSourceFileType(Implementation implementation)
Deprecated. As of JOMC 1.2, please use method getSourceFilesType(org.jomc.model.Implementation). This method will be removed in version 2.0.

Gets the model of an implementation source file of the modules of the instance.

Parameters:
implementation - The implementation to get a source file model for.
Returns:
The source file model for implementation. As of JOMC 1.2, this method returns null if no source file model is found.
Throws:
NullPointerException - if implementation is null.

getSourceFilesType

public SourceFilesType getSourceFilesType(Implementation implementation)
Gets the source files model of an implementation of the modules of the instance.

Parameters:
implementation - The implementation to get a source files model for.
Returns:
The source files model for implementation or null, if no source files model is found.
Throws:
NullPointerException - if implementation is null.
Since:
1.2

getSourceFileEditor

public final SourceFileProcessor.SourceFileEditor getSourceFileEditor()
Gets the source file editor of the instance.

Returns:
The source file editor of the instance.
Since:
1.2
See Also:
setSourceFileEditor(org.jomc.tools.SourceFileProcessor.SourceFileEditor)

setSourceFileEditor

public final void setSourceFileEditor(SourceFileProcessor.SourceFileEditor value)
Sets the source file editor of the instance.

Parameters:
value - The new source file editor of the instance or null.
Since:
1.2
See Also:
getSourceFileEditor()

getSourceFileEditor

@Deprecated
public SourceFileProcessor.SourceFileEditor getSourceFileEditor(Specification specification)
Deprecated. As of JOMC 1.2, please use method getSourceFileEditor(). This method will be removed in version 2.0.

Gets a new editor for editing the source file of a given specification of the modules of the instance.

Parameters:
specification - The specification whose source file to edit.
Returns:
A new editor for editing the source file of specification.
Throws:
NullPointerException - if specification is null.
See Also:
SourceFileProcessor.SourceFileEditor.edit(org.jomc.model.Specification, org.jomc.tools.model.SourceFileType, java.io.File)

getSourceFileEditor

@Deprecated
public SourceFileProcessor.SourceFileEditor getSourceFileEditor(Implementation implementation)
Deprecated. As of JOMC 1.2, please use method getSourceFileEditor(). This method will be removed in version 2.0.

Gets a new editor for editing the source file of a given implementation of the modules of the instance.

Parameters:
implementation - The implementation whose source file to edit.
Returns:
A new editor for editing the source file of implementation.
Throws:
NullPointerException - if implementation is null.
See Also:
SourceFileProcessor.SourceFileEditor.edit(org.jomc.model.Implementation, org.jomc.tools.model.SourceFileType, java.io.File)

manageSourceFiles

public void manageSourceFiles(File sourcesDirectory)
                       throws IOException
Manages the source files of the modules of the instance.

Parameters:
sourcesDirectory - The directory holding the source files to manage.
Throws:
NullPointerException - if sourcesDirectory is null.
IOException - if managing source files fails.
See Also:
manageSourceFiles(org.jomc.model.Module, java.io.File)

manageSourceFiles

public void manageSourceFiles(Module module,
                              File sourcesDirectory)
                       throws IOException
Manages the source files of a given module of the modules of the instance.

Parameters:
module - The module to process.
sourcesDirectory - The directory holding the source files to manage.
Throws:
NullPointerException - if module or sourcesDirectory is null.
IOException - if managing source files fails.
See Also:
manageSourceFiles(org.jomc.model.Specification, java.io.File), manageSourceFiles(org.jomc.model.Implementation, java.io.File)

manageSourceFiles

public void manageSourceFiles(Specification specification,
                              File sourcesDirectory)
                       throws IOException
Manages the source files of a given specification of the modules of the instance.

Parameters:
specification - The specification to process.
sourcesDirectory - The directory holding the source files to manage.
Throws:
NullPointerException - if specification or sourcesDirectory is null.
IOException - if managing source files fails.
See Also:
getSourceFileEditor(), getSourceFilesType(org.jomc.model.Specification)

manageSourceFiles

public void manageSourceFiles(Implementation implementation,
                              File sourcesDirectory)
                       throws IOException
Manages the source files of a given implementation of the modules of the instance.

Parameters:
implementation - The implementation to process.
sourcesDirectory - The directory holding the source files to manage.
Throws:
NullPointerException - if implementation or sourcesDirectory is null.
IOException - if managing source files fails.
See Also:
getSourceFileEditor(), getSourceFilesType(org.jomc.model.Implementation)


Copyright © 2005-2012 The JOMC Project. All Rights Reserved.Get JOMC at SourceForge.net. Fast, secure and Free Open Source software downloads
Please note that this documentation is maintained by non-native english speaking authors. As such, you may encounter phrases or wordings which seem imprecise or may even have a totally different meaning to native english speaking readers than what the individual author was trying to express. If you are a native english speaking reader and find any such phrases or wordings we kindly ask you to send an email to the corresponding author and help us improve this documentation in order to avoid misunderstandings. You will find the authors' email addresses at the top of each class. Please accept our apologies for any inconvenience caused.