Package org.jdom
Class DefaultJDOMFactory
- java.lang.Object
-
- org.jdom.DefaultJDOMFactory
-
- All Implemented Interfaces:
JDOMFactory
- Direct Known Subclasses:
LocatedJDOMFactory,SlimJDOMFactory,UncheckedJDOMFactory
public class DefaultJDOMFactory extends Object implements JDOMFactory
Creates the standard top-level JDOM classes (Element, Document, Comment, etc). A subclass of this factory might construct custom classes.
-
-
Constructor Summary
Constructors Constructor Description DefaultJDOMFactory()Creates a new DefaultJDOMFactory instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddContent(Parent parent, Content child)This will add the specified content to the specified parent instancevoidaddNamespaceDeclaration(Element parent, Namespace additional)Adds a namespace declaration to an ElementAttributeattribute(String name, String value)This will create a newAttributewith the specified (local) name and value, and does not place the attribute in a.NamespaceAttributeattribute(String name, String value, int type)Deprecated.Attributeattribute(String name, String value, int type, Namespace namespace)Deprecated.Attributeattribute(String name, String value, AttributeType type)This will create a newAttributewith the specified (local) name, value and type, and does not place the attribute in a.NamespaceAttributeattribute(String name, String value, AttributeType type, Namespace namespace)This will create a newAttributewith the specified (local) name, value, and type, and in the provided.NamespaceAttributeattribute(String name, String value, Namespace namespace)This will create a newAttributewith the specified (local) name and value, and in the provided.NamespaceCDATAcdata(int line, int col, String text)This creates the CDATA with the supplied text.CDATAcdata(String str)This creates the CDATA with the supplied text.Commentcomment(int line, int col, String text)This creates the comment with the supplied text.Commentcomment(String text)This creates the comment with the supplied text.DocTypedocType(int line, int col, String elementName)This will create theDocTypewith the specified element nameDocTypedocType(int line, int col, String elementName, String systemID)This will create theDocTypewith the specified element name and reference to an external DTD.DocTypedocType(int line, int col, String elementName, String publicID, String systemID)This will create theDocTypewith the specified element name and a reference to an external DTD.DocTypedocType(String elementName)This will create theDocTypewith the specified element nameDocTypedocType(String elementName, String systemID)This will create theDocTypewith the specified element name and reference to an external DTD.DocTypedocType(String elementName, String publicID, String systemID)This will create theDocTypewith the specified element name and a reference to an external DTD.Documentdocument(Element rootElement)Documentdocument(Element rootElement, DocType docType)Documentdocument(Element rootElement, DocType docType, String baseURI)Elementelement(int line, int col, String name)This will create anElementin no.NamespaceElementelement(int line, int col, String name, String uri)This will create a newElementwith the supplied (local) name, and specifies the URI of thetheNamespaceElementshould be in, resulting it being unprefixed (in the default namespace).Elementelement(int line, int col, String name, String prefix, String uri)This will create a newElementwith the supplied (local) name, and specifies the prefix and URI of thetheNamespaceElementshould be in.Elementelement(int line, int col, String name, Namespace namespace)This will create a newElementwith the supplied (local) name, and define theto be used.NamespaceElementelement(String name)This will create anElementin no.NamespaceElementelement(String name, String uri)This will create a newElementwith the supplied (local) name, and specifies the URI of thetheNamespaceElementshould be in, resulting it being unprefixed (in the default namespace).Elementelement(String name, String prefix, String uri)This will create a newElementwith the supplied (local) name, and specifies the prefix and URI of thetheNamespaceElementshould be in.Elementelement(String name, Namespace namespace)This will create a newElementwith the supplied (local) name, and define theto be used.NamespaceEntityRefentityRef(int line, int col, String name)This will create a newEntityRefwith the supplied name.EntityRefentityRef(int line, int col, String name, String systemID)This will create a newEntityRefwith the supplied name and system ID.EntityRefentityRef(int line, int col, String name, String publicID, String systemID)This will create a newEntityRefwith the supplied name, public ID, and system ID.EntityRefentityRef(String name)This will create a newEntityRefwith the supplied name.EntityRefentityRef(String name, String systemID)This will create a newEntityRefwith the supplied name and system ID.EntityRefentityRef(String name, String publicID, String systemID)This will create a newEntityRefwith the supplied name, public ID, and system ID.ProcessingInstructionprocessingInstruction(int line, int col, String target)This will create a newProcessingInstructionwith the specified target and no data.ProcessingInstructionprocessingInstruction(int line, int col, String target, String data)This will create a newProcessingInstructionwith the specified target and data.ProcessingInstructionprocessingInstruction(int line, int col, String target, Map<String,String> data)This will create a newProcessingInstructionwith the specified target and data.ProcessingInstructionprocessingInstruction(String target)This will create a newProcessingInstructionwith the specified target and no data.ProcessingInstructionprocessingInstruction(String target, String data)This will create a newProcessingInstructionwith the specified target and data.ProcessingInstructionprocessingInstruction(String target, Map<String,String> data)This will create a newProcessingInstructionwith the specified target and data.voidsetAttribute(Element parent, Attribute a)Sets a specific Attribute on an ElementvoidsetRoot(Document doc, Element root)Sets the 'root' Element for a Document.Texttext(int line, int col, String text)This creates the Text with the supplied text.Texttext(String str)This creates the Text with the supplied text.
-
-
-
Method Detail
-
attribute
public Attribute attribute(String name, String value, Namespace namespace)
Description copied from interface:JDOMFactoryThis will create a new
Attributewith the specified (local) name and value, and in the provided.Namespace- Specified by:
attributein interfaceJDOMFactory- Parameters:
name-Stringname ofAttribute.value-Stringvalue for new attribute.namespace-Namespaceof the new Attribute- Returns:
- the created Attribute instance
-
attribute
@Deprecated public Attribute attribute(String name, String value, int type, Namespace namespace)
Deprecated.Description copied from interface:JDOMFactoryThis will create a newAttributewith the specified (local) name, value, and type, and in the provided.Namespace- Specified by:
attributein interfaceJDOMFactory- Parameters:
name-Stringname ofAttribute.value-Stringvalue for new attribute.type-inttype for new attribute.namespace-Namespacenamespace for new attribute.- Returns:
- the created Attribute instance
-
attribute
public Attribute attribute(String name, String value, AttributeType type, Namespace namespace)
Description copied from interface:JDOMFactoryThis will create a newAttributewith the specified (local) name, value, and type, and in the provided.Namespace- Specified by:
attributein interfaceJDOMFactory- Parameters:
name-Stringname ofAttribute.value-Stringvalue for new attribute.type-AttributeTypetype for new attribute.namespace-Namespacenamespace for new attribute.- Returns:
- the created Attribute instance
-
attribute
public Attribute attribute(String name, String value)
Description copied from interface:JDOMFactoryThis will create a newAttributewith the specified (local) name and value, and does not place the attribute in a.NamespaceNote: This actually explicitly puts the
Attributein the "empty"Namespace().Namespace.NO_NAMESPACE- Specified by:
attributein interfaceJDOMFactory- Parameters:
name-Stringname ofAttribute.value-Stringvalue for new attribute.- Returns:
- the created Attribute instance
-
attribute
@Deprecated public Attribute attribute(String name, String value, int type)
Deprecated.Description copied from interface:JDOMFactoryThis will create a newAttributewith the specified (local) name, value and type, and does not place the attribute in a.NamespaceNote: This actually explicitly puts the
Attributein the "empty"Namespace().Namespace.NO_NAMESPACE- Specified by:
attributein interfaceJDOMFactory- Parameters:
name-Stringname ofAttribute.value-Stringvalue for new attribute.type-inttype for new attribute.- Returns:
- the created Attribute instance
-
attribute
public Attribute attribute(String name, String value, AttributeType type)
Description copied from interface:JDOMFactoryThis will create a newAttributewith the specified (local) name, value and type, and does not place the attribute in a.NamespaceNote: This actually explicitly puts the
Attributein the "empty"Namespace().Namespace.NO_NAMESPACE- Specified by:
attributein interfaceJDOMFactory- Parameters:
name-Stringname ofAttribute.value-Stringvalue for new attribute.type-AttributeTypetype for new attribute.- Returns:
- the created Attribute instance
-
cdata
public final CDATA cdata(String str)
Description copied from interface:JDOMFactoryThis creates the CDATA with the supplied text.- Specified by:
cdatain interfaceJDOMFactory- Parameters:
str-Stringcontent of CDATA.- Returns:
- the created CDATA instance
-
cdata
public CDATA cdata(int line, int col, String text)
Description copied from interface:JDOMFactoryThis creates the CDATA with the supplied text.- Specified by:
cdatain interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.text-Stringcontent of CDATA.- Returns:
- the created CDATA instance
-
text
public final Text text(String str)
Description copied from interface:JDOMFactoryThis creates the Text with the supplied text.- Specified by:
textin interfaceJDOMFactory- Parameters:
str-Stringcontent of Text.- Returns:
- the created Text instance
-
text
public Text text(int line, int col, String text)
Description copied from interface:JDOMFactoryThis creates the Text with the supplied text.- Specified by:
textin interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.text-Stringcontent of Text.- Returns:
- the created Text instance
-
comment
public final Comment comment(String text)
Description copied from interface:JDOMFactoryThis creates the comment with the supplied text.- Specified by:
commentin interfaceJDOMFactory- Parameters:
text-Stringcontent of comment.- Returns:
- the created Comment instance
-
comment
public Comment comment(int line, int col, String text)
Description copied from interface:JDOMFactoryThis creates the comment with the supplied text.- Specified by:
commentin interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.text-Stringcontent of comment.- Returns:
- the created Comment instance
-
docType
public final DocType docType(String elementName, String publicID, String systemID)
Description copied from interface:JDOMFactoryThis will create theDocTypewith the specified element name and a reference to an external DTD.- Specified by:
docTypein interfaceJDOMFactory- Parameters:
elementName-Stringname of element being constrained.publicID-Stringpublic ID of referenced DTDsystemID-Stringsystem ID of referenced DTD- Returns:
- the created DocType instance
-
docType
public DocType docType(int line, int col, String elementName, String publicID, String systemID)
Description copied from interface:JDOMFactoryThis will create theDocTypewith the specified element name and a reference to an external DTD.- Specified by:
docTypein interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.elementName-Stringname of element being constrained.publicID-Stringpublic ID of referenced DTDsystemID-Stringsystem ID of referenced DTD- Returns:
- the created DocType instance
-
docType
public final DocType docType(String elementName, String systemID)
Description copied from interface:JDOMFactoryThis will create theDocTypewith the specified element name and reference to an external DTD.- Specified by:
docTypein interfaceJDOMFactory- Parameters:
elementName-Stringname of element being constrained.systemID-Stringsystem 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:JDOMFactoryThis will create theDocTypewith the specified element name and reference to an external DTD.- Specified by:
docTypein interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.elementName-Stringname of element being constrained.systemID-Stringsystem ID of referenced DTD- Returns:
- the created DocType instance
-
docType
public final DocType docType(String elementName)
Description copied from interface:JDOMFactoryThis will create theDocTypewith the specified element name- Specified by:
docTypein interfaceJDOMFactory- Parameters:
elementName-Stringname of element being constrained.- Returns:
- the created DocType instance
-
docType
public DocType docType(int line, int col, String elementName)
Description copied from interface:JDOMFactoryThis will create theDocTypewith the specified element name- Specified by:
docTypein interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.elementName-Stringname of element being constrained.- Returns:
- the created DocType instance
-
document
public Document document(Element rootElement, DocType docType)
Description copied from interface:JDOMFactoryThis will create a newDocument, with the suppliedas the root element and the suppliedElementdeclaration.DocType- Specified by:
documentin interfaceJDOMFactory- Parameters:
rootElement-Elementfor document root.docType-DocTypedeclaration.- Returns:
- the created Document instance
-
document
public Document document(Element rootElement, DocType docType, String baseURI)
Description copied from interface:JDOMFactoryThis will create a newDocument, with the suppliedas the root element and the suppliedElementdeclaration.DocType- Specified by:
documentin interfaceJDOMFactory- Parameters:
rootElement-Elementfor document root.docType-DocTypedeclaration.baseURI- the URI from which this doucment was loaded.- Returns:
- the created Document instance
-
document
public Document document(Element rootElement)
Description copied from interface:JDOMFactoryThis will create a newDocument, with the suppliedas the root element, and noElementdeclaration.DocType- Specified by:
documentin interfaceJDOMFactory- Parameters:
rootElement-Elementfor document root- Returns:
- the created Document instance
-
element
public Element element(String name, Namespace namespace)
Description copied from interface:JDOMFactoryThis will create a newElementwith the supplied (local) name, and define theto be used.Namespace- Specified by:
elementin interfaceJDOMFactory- Parameters:
name-Stringname of element.namespace-Namespaceto put element in.- Returns:
- the created Element instance
-
element
public Element element(int line, int col, String name, Namespace namespace)
Description copied from interface:JDOMFactoryThis will create a newElementwith the supplied (local) name, and define theto be used.Namespace- Specified by:
elementin interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.name-Stringname of element.namespace-Namespaceto put element in.- Returns:
- the created Element instance
-
element
public Element element(String name)
Description copied from interface:JDOMFactoryThis will create anElementin no.Namespace- Specified by:
elementin interfaceJDOMFactory- Parameters:
name-Stringname of element.- Returns:
- the created Element instance
-
element
public Element element(int line, int col, String name)
Description copied from interface:JDOMFactoryThis will create anElementin no.Namespace- Specified by:
elementin interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.name-Stringname of element.- Returns:
- the created Element instance
-
element
public Element element(String name, String uri)
Description copied from interface:JDOMFactoryThis will create a newElementwith the supplied (local) name, and specifies the URI of thetheNamespaceElementshould be in, resulting it being unprefixed (in the default namespace).- Specified by:
elementin interfaceJDOMFactory- Parameters:
name-Stringname of element.uri-StringURI forNamespaceelement should be in.- Returns:
- the created Element instance
-
element
public Element element(int line, int col, String name, String uri)
Description copied from interface:JDOMFactoryThis will create a newElementwith the supplied (local) name, and specifies the URI of thetheNamespaceElementshould be in, resulting it being unprefixed (in the default namespace).- Specified by:
elementin interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.name-Stringname of element.uri-StringURI forNamespaceelement should be in.- Returns:
- the created Element instance
-
element
public Element element(String name, String prefix, String uri)
Description copied from interface:JDOMFactoryThis will create a newElementwith the supplied (local) name, and specifies the prefix and URI of thetheNamespaceElementshould be in.- Specified by:
elementin interfaceJDOMFactory- Parameters:
name-Stringname of element.prefix- the NamespacePrefic to use for this Elementuri-StringURI forNamespaceelement 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:JDOMFactoryThis will create a newElementwith the supplied (local) name, and specifies the prefix and URI of thetheNamespaceElementshould be in.- Specified by:
elementin interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.name-Stringname of element.prefix- the NamespacePrefic to use for this Elementuri-StringURI forNamespaceelement should be in.- Returns:
- the created Element instance
-
processingInstruction
public final ProcessingInstruction processingInstruction(String target)
Description copied from interface:JDOMFactoryThis will create a newProcessingInstructionwith the specified target and no data.- Specified by:
processingInstructionin interfaceJDOMFactory- Parameters:
target-Stringtarget of PI.- Returns:
- the created ProcessingInstruction instance
-
processingInstruction
public ProcessingInstruction processingInstruction(int line, int col, String target)
Description copied from interface:JDOMFactoryThis will create a newProcessingInstructionwith the specified target and no data.- Specified by:
processingInstructionin interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.target-Stringtarget of PI.- Returns:
- the created ProcessingInstruction instance
-
processingInstruction
public final ProcessingInstruction processingInstruction(String target, Map<String,String> data)
Description copied from interface:JDOMFactoryThis will create a newProcessingInstructionwith the specified target and data.- Specified by:
processingInstructionin interfaceJDOMFactory- Parameters:
target-Stringtarget of PI.data-Mapdata for PI, in name/value pairs- Returns:
- the created ProcessingInstruction instance
-
processingInstruction
public ProcessingInstruction processingInstruction(int line, int col, String target, Map<String,String> data)
Description copied from interface:JDOMFactoryThis will create a newProcessingInstructionwith the specified target and data.- Specified by:
processingInstructionin interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.target-Stringtarget of PI.data-Mapdata for PI, in name/value pairs- Returns:
- the created ProcessingInstruction instance
-
processingInstruction
public final ProcessingInstruction processingInstruction(String target, String data)
Description copied from interface:JDOMFactoryThis will create a newProcessingInstructionwith the specified target and data.- Specified by:
processingInstructionin interfaceJDOMFactory- Parameters:
target-Stringtarget of PI.data-Stringdata for PI.- Returns:
- the created ProcessingInstruction instance
-
processingInstruction
public ProcessingInstruction processingInstruction(int line, int col, String target, String data)
Description copied from interface:JDOMFactoryThis will create a newProcessingInstructionwith the specified target and data.- Specified by:
processingInstructionin interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.target-Stringtarget of PI.data-Stringdata for PI.- Returns:
- the created ProcessingInstruction instance
-
entityRef
public final EntityRef entityRef(String name)
Description copied from interface:JDOMFactoryThis will create a newEntityRefwith the supplied name.- Specified by:
entityRefin interfaceJDOMFactory- Parameters:
name-Stringname of element.- Returns:
- the created EntityRef instance
-
entityRef
public EntityRef entityRef(int line, int col, String name)
Description copied from interface:JDOMFactoryThis will create a newEntityRefwith the supplied name.- Specified by:
entityRefin interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.name-Stringname of element.- Returns:
- the created EntityRef instance
-
entityRef
public final EntityRef entityRef(String name, String publicID, String systemID)
Description copied from interface:JDOMFactoryThis will create a newEntityRefwith the supplied name, public ID, and system ID.- Specified by:
entityRefin interfaceJDOMFactory- Parameters:
name-Stringname of element.publicID-Stringpublic ID of element.systemID-Stringsystem ID 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:JDOMFactoryThis will create a newEntityRefwith the supplied name, public ID, and system ID.- Specified by:
entityRefin interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.name-Stringname of element.publicID-Stringpublic ID of element.systemID-Stringsystem ID of element.- Returns:
- the created EntityRef instance
-
entityRef
public final EntityRef entityRef(String name, String systemID)
Description copied from interface:JDOMFactoryThis will create a newEntityRefwith the supplied name and system ID.- Specified by:
entityRefin interfaceJDOMFactory- Parameters:
name-Stringname of element.systemID-Stringsystem ID of element.- Returns:
- the created EntityRef instance
-
entityRef
public EntityRef entityRef(int line, int col, String name, String systemID)
Description copied from interface:JDOMFactoryThis will create a newEntityRefwith the supplied name and system ID.- Specified by:
entityRefin interfaceJDOMFactory- Parameters:
line- The line on which this content begins.col- The column on the line at which this content begins.name-Stringname of element.systemID-Stringsystem ID of element.- Returns:
- the created EntityRef instance
-
addContent
public void addContent(Parent parent, Content child)
Description copied from interface:JDOMFactoryThis will add the specified content to the specified parent instance- Specified by:
addContentin interfaceJDOMFactory- Parameters:
parent- TheParentto add the content to.child- TheContentto add
-
setAttribute
public void setAttribute(Element parent, Attribute a)
Description copied from interface:JDOMFactorySets a specific Attribute on an Element- Specified by:
setAttributein interfaceJDOMFactory- Parameters:
parent- TheElementto set the Attribute ona- TheAttributeto set
-
addNamespaceDeclaration
public void addNamespaceDeclaration(Element parent, Namespace additional)
Description copied from interface:JDOMFactoryAdds a namespace declaration to an Element- Specified by:
addNamespaceDeclarationin interfaceJDOMFactory- Parameters:
parent- TheElementto add the Namespace toadditional- TheNamespaceto add.
-
setRoot
public void setRoot(Document doc, Element root)
Description copied from interface:JDOMFactorySets the 'root' Element for a Document.- Specified by:
setRootin interfaceJDOMFactory- Parameters:
doc- TheDocumentto set the Root Element of.root- TheElementto set as the root.
-
-