Package org.jdom.located
Class LocatedJDOMFactory
- java.lang.Object
-
- org.jdom.DefaultJDOMFactory
-
- org.jdom.located.LocatedJDOMFactory
-
- All Implemented Interfaces:
JDOMFactory
public class LocatedJDOMFactory extends DefaultJDOMFactory
All Content instances (Element, Comment, CDATA, DocType, Text, EntityRef, and ProcessingInstruction) will implementLocated
, and will have the values set appropriately.You can set an instance of this LocatedJDOMFactory as the factory for a SAXBuilder, and the JDOM document produced will have the SAX Location data embedded. Note though, that SAX Location data indicates the position of the end of the SAX Event.
-
-
Constructor Summary
Constructors Constructor Description LocatedJDOMFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CDATA
cdata(int line, int col, String text)
This creates the CDATA with the supplied text.Comment
comment(int line, int col, String text)
This creates the comment with the supplied text.DocType
docType(int line, int col, String elementName)
This will create theDocType
with the specified element nameDocType
docType(int line, int col, String elementName, String systemID)
This will create theDocType
with the specified element name and reference to an external DTD.DocType
docType(int line, int col, String elementName, String publicID, String systemID)
This will create theDocType
with the specified element name and a reference to an external DTD.Element
element(int line, int col, String name)
This will create anElement
in no
.Namespace
Element
element(int line, int col, String name, String uri)
This will create a newElement
with the supplied (local) name, and specifies the URI of the
theNamespace
Element
should be in, resulting it being unprefixed (in the default namespace).Element
element(int line, int col, String name, String prefix, String uri)
This will create a newElement
with the supplied (local) name, and specifies the prefix and URI of the
theNamespace
Element
should be in.Element
element(int line, int col, String name, Namespace namespace)
This will create a newElement
with the supplied (local) name, and define the
to be used.Namespace
EntityRef
entityRef(int line, int col, String name)
This will create a newEntityRef
with the supplied name.EntityRef
entityRef(int line, int col, String name, String systemID)
This will create a newEntityRef
with the supplied name and system ID.EntityRef
entityRef(int line, int col, String name, String publicID, String systemID)
This will create a newEntityRef
with the supplied name, public ID, and system ID.ProcessingInstruction
processingInstruction(int line, int col, String target)
This will create a newProcessingInstruction
with the specified target and no data.ProcessingInstruction
processingInstruction(int line, int col, String target, String data)
This will create a newProcessingInstruction
with the specified target and data.ProcessingInstruction
processingInstruction(int line, int col, String target, Map<String,String> data)
This will create a newProcessingInstruction
with the specified target and data.Text
text(int line, int col, String text)
This creates the Text with the supplied text.-
Methods inherited from class org.jdom.DefaultJDOMFactory
addContent, addNamespaceDeclaration, attribute, attribute, attribute, attribute, attribute, attribute, cdata, comment, docType, docType, docType, document, document, document, element, element, element, element, entityRef, entityRef, entityRef, processingInstruction, processingInstruction, processingInstruction, setAttribute, setRoot, text
-
-
-
-
Method Detail
-
cdata
public CDATA cdata(int line, int col, String text)
Description copied from interface:JDOMFactory
This creates the CDATA with the supplied text.- Specified by:
cdata
in interfaceJDOMFactory
- Overrides:
cdata
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.text
-String
content of CDATA.- Returns:
- the created CDATA instance
-
text
public Text text(int line, int col, String text)
Description copied from interface:JDOMFactory
This creates the Text with the supplied text.- Specified by:
text
in interfaceJDOMFactory
- Overrides:
text
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.text
-String
content of Text.- Returns:
- the created Text instance
-
comment
public Comment comment(int line, int col, String text)
Description copied from interface:JDOMFactory
This creates the comment with the supplied text.- Specified by:
comment
in interfaceJDOMFactory
- Overrides:
comment
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.text
-String
content of comment.- Returns:
- the created Comment instance
-
docType
public DocType docType(int line, int col, String elementName, String publicID, String systemID)
Description copied from interface:JDOMFactory
This will create theDocType
with the specified element name and a reference to an external DTD.- Specified by:
docType
in interfaceJDOMFactory
- Overrides:
docType
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.elementName
-String
name of element being constrained.publicID
-String
public ID of referenced DTDsystemID
-String
system ID of referenced DTD- Returns:
- the created DocType instance
-
docType
public DocType docType(int line, int col, String elementName, String systemID)
Description copied from interface:JDOMFactory
This will create theDocType
with the specified element name and reference to an external DTD.- Specified by:
docType
in interfaceJDOMFactory
- Overrides:
docType
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.elementName
-String
name of element being constrained.systemID
-String
system ID of referenced DTD- Returns:
- the created DocType instance
-
docType
public DocType docType(int line, int col, String elementName)
Description copied from interface:JDOMFactory
This will create theDocType
with the specified element name- Specified by:
docType
in interfaceJDOMFactory
- Overrides:
docType
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.elementName
-String
name of element being constrained.- Returns:
- the created DocType instance
-
element
public Element element(int line, int col, String name, Namespace namespace)
Description copied from interface:JDOMFactory
This will create a newElement
with the supplied (local) name, and define the
to be used.Namespace
- Specified by:
element
in interfaceJDOMFactory
- Overrides:
element
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.name
-String
name of element.namespace
-Namespace
to put element in.- Returns:
- the created Element instance
-
element
public Element element(int line, int col, String name)
Description copied from interface:JDOMFactory
This will create anElement
in no
.Namespace
- Specified by:
element
in interfaceJDOMFactory
- Overrides:
element
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.name
-String
name of element.- Returns:
- the created Element instance
-
element
public Element element(int line, int col, String name, String uri)
Description copied from interface:JDOMFactory
This will create a newElement
with the supplied (local) name, and specifies the URI of the
theNamespace
Element
should be in, resulting it being unprefixed (in the default namespace).- Specified by:
element
in interfaceJDOMFactory
- Overrides:
element
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.name
-String
name of element.uri
-String
URI forNamespace
element should be in.- Returns:
- the created Element instance
-
element
public Element element(int line, int col, String name, String prefix, String uri)
Description copied from interface:JDOMFactory
This will create a newElement
with the supplied (local) name, and specifies the prefix and URI of the
theNamespace
Element
should be in.- Specified by:
element
in interfaceJDOMFactory
- Overrides:
element
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.name
-String
name of element.prefix
- the NamespacePrefic to use for this Elementuri
-String
URI forNamespace
element should be in.- Returns:
- the created Element instance
-
processingInstruction
public ProcessingInstruction processingInstruction(int line, int col, String target)
Description copied from interface:JDOMFactory
This will create a newProcessingInstruction
with the specified target and no data.- Specified by:
processingInstruction
in interfaceJDOMFactory
- Overrides:
processingInstruction
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.target
-String
target of PI.- Returns:
- the created ProcessingInstruction instance
-
processingInstruction
public ProcessingInstruction processingInstruction(int line, int col, String target, Map<String,String> data)
Description copied from interface:JDOMFactory
This will create a newProcessingInstruction
with the specified target and data.- Specified by:
processingInstruction
in interfaceJDOMFactory
- Overrides:
processingInstruction
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.target
-String
target of PI.data
-Map
data for PI, in name/value pairs- Returns:
- the created ProcessingInstruction instance
-
processingInstruction
public ProcessingInstruction processingInstruction(int line, int col, String target, String data)
Description copied from interface:JDOMFactory
This will create a newProcessingInstruction
with the specified target and data.- Specified by:
processingInstruction
in interfaceJDOMFactory
- Overrides:
processingInstruction
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.target
-String
target of PI.data
-String
data for PI.- Returns:
- the created ProcessingInstruction instance
-
entityRef
public EntityRef entityRef(int line, int col, String name)
Description copied from interface:JDOMFactory
This will create a newEntityRef
with the supplied name.- Specified by:
entityRef
in interfaceJDOMFactory
- Overrides:
entityRef
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.name
-String
name of element.- Returns:
- the created EntityRef instance
-
entityRef
public EntityRef entityRef(int line, int col, String name, String publicID, String systemID)
Description copied from interface:JDOMFactory
This will create a newEntityRef
with the supplied name, public ID, and system ID.- Specified by:
entityRef
in interfaceJDOMFactory
- Overrides:
entityRef
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.name
-String
name of element.publicID
-String
public ID of element.systemID
-String
system ID of element.- Returns:
- the created EntityRef instance
-
entityRef
public EntityRef entityRef(int line, int col, String name, String systemID)
Description copied from interface:JDOMFactory
This will create a newEntityRef
with the supplied name and system ID.- Specified by:
entityRef
in interfaceJDOMFactory
- Overrides:
entityRef
in classDefaultJDOMFactory
- Parameters:
line
- The line on which this content begins.col
- The column on the line at which this content begins.name
-String
name of element.systemID
-String
system ID of element.- Returns:
- the created EntityRef instance
-
-