- java.lang.Object
- 
- javax.swing.text.html.parser.DTD
 
- 
- All Implemented Interfaces:
- DTDConstants
 
 public class DTD extends Object implements DTDConstants The representation of an SGML DTD. DTD describes a document syntax and is used in parsing of HTML documents. It contains a list of elements and their attributes as well as a list of entities defined in the DTD.- See Also:
- Element,- AttributeList,- ContentModel,- Parser
 
- 
- 
Field SummaryFields Modifier and Type Field Description ElementappletThe element corresponding to applet.ElementbaseThe element corresponding to base.ElementbodyThe element corresponding to body.Hashtable<String,Element>elementHashThe hash table contains the name of element and the corresponding element.Vector<Element>elementsThe vector of elementsHashtable<Object,Entity>entityHashThe hash table contains anObjectand the correspondingEntitystatic intFILE_VERSIONThe version of a fileElementheadThe element corresponding to head.ElementhtmlThe element corresponding to html.ElementisindexThe element corresponding to isindex.ElementmetaThe element corresponding to meta.Stringnamethe name of the DTDElementpThe element corresponding to p.ElementparamThe element corresponding to param.ElementpcdataThe element corresponding to pcdata.ElementtitleThe element corresponding to title.- 
Fields declared in interface javax.swing.text.html.parser.DTDConstantsANY, CDATA, CONREF, CURRENT, DEFAULT, EMPTY, ENDTAG, ENTITIES, ENTITY, FIXED, GENERAL, ID, IDREF, IDREFS, IMPLIED, MD, MODEL, MS, NAME, NAMES, NMTOKEN, NMTOKENS, NOTATION, NUMBER, NUMBERS, NUTOKEN, NUTOKENS, PARAMETER, PI, PUBLIC, RCDATA, REQUIRED, SDATA, STARTTAG, SYSTEM
 
- 
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected AttributeListdefAttributeList(String name, int type, int modifier, String value, String values, AttributeList atts)Creates and returns anAttributeListresponding to a new attribute.protected ContentModeldefContentModel(int type, Object obj, ContentModel next)Creates and returns a new content model.protected ElementdefElement(String name, int type, boolean omitStart, boolean omitEnd, ContentModel content, String[] exclusions, String[] inclusions, AttributeList atts)Creates and returns anElement.EntitydefEntity(String name, int type, int ch)Creates and returns a characterEntity.protected EntitydefEntity(String name, int type, String str)Creates and returns anEntity.voiddefineAttributes(String name, AttributeList atts)Defines attributes for anElement.ElementdefineElement(String name, int type, boolean omitStart, boolean omitEnd, ContentModel content, BitSet exclusions, BitSet inclusions, AttributeList atts)Returns theElementwhich matches the specified parameters.EntitydefineEntity(String name, int type, char[] data)Defines an entity.static DTDgetDTD(String name)Returns a DTD with the specifiedname.ElementgetElement(int index)Gets an element by index.ElementgetElement(String name)Gets an element by name.EntitygetEntity(int ch)Gets a character entity.EntitygetEntity(String name)Gets an entity by name.StringgetName()Gets the name of the DTD.static voidputDTDHash(String name, DTD dtd)Put a name and appropriate DTD to hashtable.voidread(DataInputStream in)Recreates a DTD from an archived format.StringtoString()Returns a string representation of this DTD.
 
- 
- 
- 
Field Detail- 
namepublic String name the name of the DTD
 - 
elementHashpublic Hashtable<String,Element> elementHash The hash table contains the name of element and the corresponding element.
 - 
entityHashpublic Hashtable<Object,Entity> entityHash The hash table contains anObjectand the correspondingEntity
 - 
pcdatapublic final Element pcdata The element corresponding to pcdata.
 - 
htmlpublic final Element html The element corresponding to html.
 - 
metapublic final Element meta The element corresponding to meta.
 - 
basepublic final Element base The element corresponding to base.
 - 
isindexpublic final Element isindex The element corresponding to isindex.
 - 
headpublic final Element head The element corresponding to head.
 - 
bodypublic final Element body The element corresponding to body.
 - 
appletpublic final Element applet The element corresponding to applet.
 - 
parampublic final Element param The element corresponding to param.
 - 
ppublic final Element p The element corresponding to p.
 - 
titlepublic final Element title The element corresponding to title.
 - 
FILE_VERSIONpublic static final int FILE_VERSION The version of a file- See Also:
- Constant Field Values
 
 
- 
 - 
Constructor Detail- 
DTDprotected DTD(String name) Creates a new DTD with the specified name.- Parameters:
- name- the name, as a- Stringof the new DTD
 
 
- 
 - 
Method Detail- 
getNamepublic String getName() Gets the name of the DTD.- Returns:
- the name of the DTD
 
 - 
getEntitypublic Entity getEntity(String name) Gets an entity by name.- Parameters:
- name- the entity name
- Returns:
- the Entitycorresponding to thenameString
 
 - 
getEntitypublic Entity getEntity(int ch) Gets a character entity.- Parameters:
- ch- the character
- Returns:
- the Entitycorresponding to thechcharacter
 
 - 
getElementpublic Element getElement(String name) Gets an element by name. A new element is created if the element doesn't exist.- Parameters:
- name- the requested- String
- Returns:
- the Elementcorresponding toname, which may be newly created
 
 - 
getElementpublic Element getElement(int index) Gets an element by index.- Parameters:
- index- the requested index
- Returns:
- the Elementcorresponding toindex
 
 - 
defineEntitypublic Entity defineEntity(String name, int type, char[] data) Defines an entity. If theEntityspecified byname,type, anddataexists, it is returned; otherwise a newEntityis created and is returned.- Parameters:
- name- the name of the- Entityas a- String
- type- the type of the- Entity
- data- the- Entity's data
- Returns:
- the Entityrequested or a newEntityif not found
 
 - 
defineElementpublic Element defineElement(String name, int type, boolean omitStart, boolean omitEnd, ContentModel content, BitSet exclusions, BitSet inclusions, AttributeList atts) Returns theElementwhich matches the specified parameters. If one doesn't exist, a new one is created and returned.- Parameters:
- name- the name of the- Element
- type- the type of the- Element
- omitStart-- trueif start should be omitted
- omitEnd-- trueif end should be omitted
- content- the- ContentModel
- exclusions- the set of elements that must not occur inside the element
- inclusions- the set of elements that can occur inside the element
- atts- the- AttributeListspecifying the- Element
- Returns:
- the Elementspecified
 
 - 
defineAttributespublic void defineAttributes(String name, AttributeList atts) Defines attributes for anElement.- Parameters:
- name- the name of the- Element
- atts- the- AttributeListspecifying the- Element
 
 - 
defEntitypublic Entity defEntity(String name, int type, int ch) Creates and returns a characterEntity.- Parameters:
- name- the entity's name
- type- the entity's type
- ch- the entity's value (character)
- Returns:
- the new character Entity
 
 - 
defEntityprotected Entity defEntity(String name, int type, String str) Creates and returns anEntity.- Parameters:
- name- the entity's name
- type- the entity's type
- str- the entity's data section
- Returns:
- the new Entity
 
 - 
defElementprotected Element defElement(String name, int type, boolean omitStart, boolean omitEnd, ContentModel content, String[] exclusions, String[] inclusions, AttributeList atts) Creates and returns anElement.- Parameters:
- name- the element's name
- type- the element's type
- omitStart-- trueif the element needs no starting tag
- omitEnd-- trueif the element needs no closing tag
- content- the element's content
- exclusions- the elements that must be excluded from the content of the element
- inclusions- the elements that can be included as the content of the element
- atts- the attributes of the element
- Returns:
- the new Element
 
 - 
defAttributeListprotected AttributeList defAttributeList(String name, int type, int modifier, String value, String values, AttributeList atts) Creates and returns anAttributeListresponding to a new attribute.- Parameters:
- name- the attribute's name
- type- the attribute's type
- modifier- the attribute's modifier
- value- the default value of the attribute
- values- the allowed values for the attribute (multiple values could be separated by '|')
- atts- the previous attribute of the element; to be placed to- AttributeList.next, creating a linked list
- Returns:
- the new AttributeList
 
 - 
defContentModelprotected ContentModel defContentModel(int type, Object obj, ContentModel next) Creates and returns a new content model.- Parameters:
- type- the type of the new content model
- obj- the content of the content model
- next- pointer to the next content model
- Returns:
- the new ContentModel
 
 - 
toStringpublic String toString() Returns a string representation of this DTD.
 - 
putDTDHashpublic static void putDTDHash(String name, DTD dtd) Put a name and appropriate DTD to hashtable.- Parameters:
- name- the name of the DTD
- dtd- the DTD
 
 - 
getDTDpublic static DTD getDTD(String name) throws IOException Returns a DTD with the specifiedname. If a DTD with that name doesn't exist, one is created and returned. Any uppercase characters in the name are converted to lowercase.- Parameters:
- name- the name of the DTD
- Returns:
- the DTD which corresponds to name
- Throws:
- IOException- if an I/O error occurs
 
 - 
readpublic void read(DataInputStream in) throws IOException Recreates a DTD from an archived format.- Parameters:
- in- the- DataInputStreamto read from
- Throws:
- IOException- if an I/O error occurs
 
 
- 
 
-