org.jdom2.located
Class LocatedDocType

java.lang.Object
  org.jdom2.Content
      org.jdom2.DocType
          org.jdom2.located.LocatedDocType

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Located, NamespaceAware

public class LocatedDocType
extends DocType
implements Located

An XML DOCTYPE declaration. Method allow the user to get and set the root element name, public id, and system id.

Author:

Rolf Lear

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jdom2.Content

Content.CType

Field Summary

Fields inherited from class org.jdom2.DocType

elementName, internalSubset, publicID, systemID

Fields inherited from class org.jdom2.Content

ctype, parent

Constructor Summary

LocatedDocType(java.lang.String elementName)
This will create the DocType with the specified element name

LocatedDocType(java.lang.String elementName, java.lang.String systemID)
This will create the DocType with the specified element name and reference to an external DTD.

LocatedDocType(java.lang.String elementName, java.lang.String publicID, java.lang.String systemID)
This will create the DocType with the specified element name and a reference to an external DTD.

Method Summary

int	getColumn() Get the column (character on the line).
int	getLine() Get the line number
void	setColumn(int col) Set the column (character on the line).
void	setLine(int line) Set the line number

Methods inherited from class org.jdom2.DocType

clone, detach, getElementName, getInternalSubset, getParent, getPublicID, getSystemID, getValue, setElementName, setInternalSubset, setParent, setPublicID, setSystemID, toString

Methods inherited from class org.jdom2.Content

equals, getCType, getDocument, getNamespacesInherited, getNamespacesInScope, getNamespacesIntroduced, getParentElement, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LocatedDocType

public LocatedDocType(java.lang.String elementName,
                      java.lang.String publicID,
                      java.lang.String systemID)

This will create the DocType with the specified element name and a reference to an external DTD.

Parameters:

elementName - String name of element being constrained.

publicID - String public ID of referenced DTD

systemID - String system ID of referenced DTD

Throws:

IllegalDataException - if the given system ID is not a legal system literal or the public ID is not a legal public ID.

IllegalNameException - if the given root element name is not a legal XML element name.

LocatedDocType

public LocatedDocType(java.lang.String elementName,
                      java.lang.String systemID)

This will create the DocType with the specified element name and reference to an external DTD.

Parameters:

elementName - String name of element being constrained.

systemID - String system ID of referenced DTD

Throws:

IllegalDataException - if the given system ID is not a legal system literal.

IllegalNameException - if the given root element name is not a legal XML element name.

LocatedDocType

public LocatedDocType(java.lang.String elementName)

This will create the DocType with the specified element name

Parameters:

elementName - String name of element being constrained.

Throws:

IllegalNameException - if the given root element name is not a legal XML element name.

Method Detail

getLine

public int getLine()

Description copied from interface: Located

Get the line number

Specified by:

getLine in interface Located

Returns:

the line number

getColumn

public int getColumn()

Description copied from interface: Located

Get the column (character on the line).

Specified by:

getColumn in interface Located

Returns:

the column

setLine

public void setLine(int line)

Description copied from interface: Located

Set the line number

Specified by:

setLine in interface Located

Parameters:

line - the line.

setColumn

public void setColumn(int col)

Description copied from interface: Located

Set the column (character on the line).

Specified by:

setColumn in interface Located

Parameters:

col - The column