public interface IDOMFactory
IDOMCompilationUnit
represents the root of a complete JDOM (that
is, a source file with one of the
Java-like extensions
). Other node types represent fragments of a compilation
unit.
The factory can be used to create empty DFs or it can create DFs from source
strings. All DFs created empty are assigned default values as required, such
that a call to IDOMNode.getContents
will generate a valid source
string. See individual create
methods for details on the default
values supplied. The factory does its best to recognize Java structures in
the source provided. If the factory is completely unable to recognize source
constructs, the factory method returns null
.
Even if a DF is created successfully from source code, it does not guarantee that the source code will compile error free. Similarly, the contents of a DF are not guaranteed to compile error free. However, syntactically correct source code is guaranteed to be recognized and successfully generate a DF. Similarly, if all of the fragments of a JDOM are syntactically correct, the contents of the entire document will be correct too.
The factory does not perform or provide any code formatting. Document fragments created on source strings must be pre-formatted. The JDOM attempts to maintain the formatting of documents as best as possible. For this reason, document fragments created for nodes that are to be strung together should end with a new-line character. Failing to do so will result in a document that has elements strung together on the same line. This is especially important if a source string ends with a // comment. In this case, it would be syntactically incorrect to omit the new line character.
IDOMNode
Modifier and Type | Method and Description |
---|---|
IDOMType |
createClass()
Deprecated.
Creates a default type document fragment.
|
IDOMCompilationUnit |
createCompilationUnit()
Deprecated.
Creates and return an empty JDOM.
|
IDOMCompilationUnit |
createCompilationUnit(char[] sourceCode,
String name)
Deprecated.
Creates a JDOM on the given source code.
|
IDOMCompilationUnit |
createCompilationUnit(String sourceCode,
String name)
Deprecated.
Creates a JDOM on the given source code.
|
IDOMField |
createField()
Deprecated.
Creates a default field document fragment.
|
IDOMField |
createField(String sourceCode)
Deprecated.
Creates a field document fragment on the given source code.
|
IDOMImport |
createImport()
Deprecated.
Creates an empty import document fragment.
|
IDOMImport |
createImport(String sourceCode)
Deprecated.
Creates an import document fragment on the given source code.
|
IDOMInitializer |
createInitializer()
Deprecated.
Creates an empty initializer document fragment.
|
IDOMInitializer |
createInitializer(String sourceCode)
Deprecated.
Creates an initializer document fragment from the given source code.
|
IDOMType |
createInterface()
Deprecated.
Creates a default type document fragment.
|
IDOMMethod |
createMethod()
Deprecated.
Creates a default method document fragment.
|
IDOMMethod |
createMethod(String sourceCode)
Deprecated.
Creates a method document fragment on the given source code.
|
IDOMPackage |
createPackage()
Deprecated.
Creates an empty package document fragment.
|
IDOMPackage |
createPackage(String sourceCode)
Deprecated.
Creates a package document fragment on the given source code.
|
IDOMType |
createType()
Deprecated.
Creates a default type document fragment.
|
IDOMType |
createType(String sourceCode)
Deprecated.
Creates a type document fragment on the given source code.
|
IDOMCompilationUnit createCompilationUnit()
IDOMCompilationUnit createCompilationUnit(char[] sourceCode, String name)
sourceCode
- the source code character array, or null
name
- the name of the compilation unitnull
if unable to recognize
the source code, or if the source code is null
IDOMCompilationUnit createCompilationUnit(String sourceCode, String name)
sourceCode
- the source code string, or null
name
- the name of the compilation unitnull
if unable to recognize
the source code, or if the source code is null
IDOMField createField()
"Object"
, name "aField"
,
no comment, and no initializer.IDOMField createField(String sourceCode)
sourceCode
- the source codenull
if unable to recognize
the source code, if the source code is null
, or when the source
contains more than one VariableDeclarator clauseIDOMImport createImport()
"java.lang.*"
and be non-static.IDOMImport createImport(String sourceCode)
sourceCode
- the source codenull
if unable to recognize
the source code, or if the source code is null
IDOMInitializer createInitializer()
IDOMInitializer createInitializer(String sourceCode)
sourceCode
- the source codenull
if unable to recognize
the source code, or if the source code is null
IDOMMethod createMethod()
"void"
, be named
"newMethod"
, have no parameters, no comment, and an empty body.IDOMMethod createMethod(String sourceCode)
sourceCode
- the source codenull
if unable to recognize
the source code, or if the source code is null
IDOMPackage createPackage()
IDOMPackage createPackage(String sourceCode)
sourceCode
- the source codenull
if unable to recognize
the source code, or if the source code is null
IDOMType createType()
"AClass"
, with no members or comment.IDOMType createClass()
"AClass"
, with no members or comment.IDOMType createInterface()
"AnInterface"
, with no members or comment.IDOMType createType(String sourceCode)
sourceCode
- the source codenull
if unable to recognize
the source code, or if the source code is null
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.