|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jomc.tools.JomcTool
org.jomc.tools.SourceFileProcessor
public class SourceFileProcessor
Processes source code files.
Use Cases:
manageSourceFiles(File)
manageSourceFiles(Module, File)
manageSourceFiles(Specification, File)
manageSourceFiles(Implementation, File)
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 Specification s and Implementation s
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SourceFileProcessor()
SourceFileProcessor
instance.
public SourceFileProcessor(SourceFileProcessor tool) throws IOException
SourceFileProcessor
instance taking a SourceFileProcessor
instance to initialize
the instance with.
tool
- The instance to initialize the new instance with,
NullPointerException
- if tool
is null
.
IOException
- if copying tool
fails.Method Detail |
---|
@Deprecated public SourceFilesType getSourceFilesType()
Specification
s and Implementation
s
directly. This method will be removed in version 2.0.
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.
getSourceFileType(org.jomc.model.Specification)
,
getSourceFileType(org.jomc.model.Implementation)
@Deprecated public SourceFileType getSourceFileType(Specification specification)
getSourceFilesType(org.jomc.model.Specification)
. This
method will be removed in version 2.0.
specification
- The specification to get a source file model for.
specification
. As of JOMC 1.2, this method returns null
if no
source file model is found.
NullPointerException
- if specification
is null
.public SourceFilesType getSourceFilesType(Specification specification)
specification
- The specification to get a source files model for.
specification
or null
, if no source files model is found.
NullPointerException
- if specification
is null
.@Deprecated public SourceFileType getSourceFileType(Implementation implementation)
getSourceFilesType(org.jomc.model.Implementation)
. This
method will be removed in version 2.0.
implementation
- The implementation to get a source file model for.
implementation
. As of JOMC 1.2, this method returns null
if no
source file model is found.
NullPointerException
- if implementation
is null
.public SourceFilesType getSourceFilesType(Implementation implementation)
implementation
- The implementation to get a source files model for.
implementation
or null
, if no source files model is found.
NullPointerException
- if implementation
is null
.public final SourceFileProcessor.SourceFileEditor getSourceFileEditor()
setSourceFileEditor(org.jomc.tools.SourceFileProcessor.SourceFileEditor)
public final void setSourceFileEditor(SourceFileProcessor.SourceFileEditor value)
value
- The new source file editor of the instance or null
.getSourceFileEditor()
@Deprecated public SourceFileProcessor.SourceFileEditor getSourceFileEditor(Specification specification)
getSourceFileEditor()
. This method will be removed in
version 2.0.
specification
- The specification whose source file to edit.
specification
.
NullPointerException
- if specification
is null
.SourceFileProcessor.SourceFileEditor.edit(org.jomc.model.Specification, org.jomc.tools.model.SourceFileType, java.io.File)
@Deprecated public SourceFileProcessor.SourceFileEditor getSourceFileEditor(Implementation implementation)
getSourceFileEditor()
. This method will be removed in
version 2.0.
implementation
- The implementation whose source file to edit.
implementation
.
NullPointerException
- if implementation
is null
.SourceFileProcessor.SourceFileEditor.edit(org.jomc.model.Implementation, org.jomc.tools.model.SourceFileType, java.io.File)
public void manageSourceFiles(File sourcesDirectory) throws IOException
sourcesDirectory
- The directory holding the source files to manage.
NullPointerException
- if sourcesDirectory
is null
.
IOException
- if managing source files fails.manageSourceFiles(org.jomc.model.Module, java.io.File)
public void manageSourceFiles(Module module, File sourcesDirectory) throws IOException
module
- The module to process.sourcesDirectory
- The directory holding the source files to manage.
NullPointerException
- if module
or sourcesDirectory
is null
.
IOException
- if managing source files fails.manageSourceFiles(org.jomc.model.Specification, java.io.File)
,
manageSourceFiles(org.jomc.model.Implementation, java.io.File)
public void manageSourceFiles(Specification specification, File sourcesDirectory) throws IOException
specification
- The specification to process.sourcesDirectory
- The directory holding the source files to manage.
NullPointerException
- if specification
or sourcesDirectory
is null
.
IOException
- if managing source files fails.getSourceFileEditor()
,
getSourceFilesType(org.jomc.model.Specification)
public void manageSourceFiles(Implementation implementation, File sourcesDirectory) throws IOException
implementation
- The implementation to process.sourcesDirectory
- The directory holding the source files to manage.
NullPointerException
- if implementation
or sourcesDirectory
is null
.
IOException
- if managing source files fails.getSourceFileEditor()
,
getSourceFilesType(org.jomc.model.Implementation)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2005-2012 The JOMC Project. All Rights Reserved. |