javax.swing.text.html.parser

Class Element

Implemented Interfaces:
DTDConstants, Serializable

public final class Element
extends Object
implements DTDConstants, Serializable

Stores the element information, obtained by parsing SGML DTD tag <!ELEMENT .. >. This class has no public constructor and can only be instantiated using the DTD methods

SGML defines elements that represent structures or behavior. An element typically consists of a start tag, content, and an end tag. Hence the elements are not tags. The HTML 4.0 definition specifies that some elements are not required to have the end tags. Also, some HTML elements (like <hr>) have no content. Element names are case sensitive.

See Also:
Serialized Form

Field Summary

AttributeList
atts
The element attributes.
ContentModel
content
The content model, defining elements, entities and DTD text that may/may not occur inside this element.
Object
data
A field to store additional user data for this Element.
BitSet
exclusions
Contains refernces to elements that must NOT occur inside this element, at any level of hierarchy.
BitSet
inclusions
Contains refernces to elements that must CAN occur inside this element, at any level of hierarchy.
int
index
This field contains the unique integer identifier of this Element, used to refer the element (more exactly, the element flag) in inclusions and exclusions bit set.
String
name
The element name.
boolean
oEnd
True is this element need not to have the closing tag, false otherwise.
boolean
oStart
True is this element need not to have the starting tag, false otherwise.
int
type
The element type, containing value, defined in DTDConstants.

Fields inherited from interface javax.swing.text.html.parser.DTDConstants

ANY, 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 Summary

AttributeList
getAttribute(String attribute)
Get the element attribute by name.
AttributeList
getAttributeByValue(String a_value)
Get the element attribute by its value.
AttributeList
getAttributes()
Get all attributes of this document as an attribute list.
ContentModel
getContent()
Get the content model, defining elements, entities and DTD text that may/may not occur inside this element.
int
getIndex()
Get the unique integer identifier of this Element, used to refer the element (more exactly, the element flag) in inclusions and exclusions bit set.
String
getName()
Get the element name.
int
getType()
Get the element type.
boolean
isEmpty()
Returns true for the element with no content.
static int
name2type(String a_type)
Converts the string representation of the element type into its unique integer identifier, defined in DTDConstants.
boolean
omitEnd()
True is this element need not to have the starting tag, false otherwise.s element need not to have the closing tag, false otherwise.
boolean
omitStart()
True is this element need not to have the closing tag, false otherwise.
String
toString()
Returns the name of this element.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

atts

public AttributeList atts
The element attributes.

content

public ContentModel content
The content model, defining elements, entities and DTD text that may/may not occur inside this element.

data

public Object data
A field to store additional user data for this Element.

exclusions

public BitSet exclusions
Contains refernces to elements that must NOT occur inside this element, at any level of hierarchy.

inclusions

public BitSet inclusions
Contains refernces to elements that must CAN occur inside this element, at any level of hierarchy.

index

public int index
This field contains the unique integer identifier of this Element, used to refer the element (more exactly, the element flag) in inclusions and exclusions bit set.

name

public String name
The element name.

oEnd

public boolean oEnd
True is this element need not to have the closing tag, false otherwise. The HTML 4.0 definition specifies that some elements (like <hr>are not required to have the end tags.

oStart

public boolean oStart
True is this element need not to have the starting tag, false otherwise. The HTML 4.0 definition specifies that some elements (like <head> or <body>) are not required to have the start tags.

type

public int type
The element type, containing value, defined in DTDConstants. In this implementation, the element type can be CDATA, RCDATA, EMPTY or ANY.

Method Details

getAttribute

public AttributeList getAttribute(String attribute)
Get the element attribute by name.
Parameters:
attribute - the attribute name, case insensitive.
Returns:
the correspoding attribute of this element. The class, for storing as attribute list, as a single attribute, is used to store a single attribute in this case.
Throws:
NullPointerException - if the attribute name is null.

getAttributeByValue

public AttributeList getAttributeByValue(String a_value)
Get the element attribute by its value.
Parameters:
a_value - the attribute value, case insensitive.
Returns:
the correspoding attribute of this element. The class, for storing as attribute list, as a single attribute, is used to store a single attribute in this case. If there are several attributes with the same value, there is no garranty, which one is returned.

getAttributes

public AttributeList getAttributes()
Get all attributes of this document as an attribute list.
Returns:
The attribute list.

getContent

public ContentModel getContent()
Get the content model, defining elements, entities and DTD text that may/may not occur inside this element.

getIndex

public int getIndex()
Get the unique integer identifier of this Element, used to refer the element (more exactly, the element flag) in inclusions and exclusions bit set. WARNING: This value may not be the same between different implementations.

getName

public String getName()
Get the element name.

getType

public int getType()
Get the element type.
Returns:
one of the values, defined DTDConstants. In this implementation, the element type can be CDATA, RCDATA, EMPTY or ANY.

isEmpty

public boolean isEmpty()
Returns true for the element with no content. Empty elements are defined with the SGML DTD keyword "EMPTY".
Returns:
true if content model field (content) method is equal to null or its method empty() returns true.

name2type

public static int name2type(String a_type)
Converts the string representation of the element type into its unique integer identifier, defined in DTDConstants.
Parameters:
a_type - A name of the type
Returns:
DTDConstants.CDATA, DTDConstants.RCDATA, DTDConstants.EMPTY, DTDConstants.ANY or null if the type name is not "CDATA", "RCDATA", "EMPTY" or "ANY". This function is case sensitive.
Throws:
NullPointerException - if a_type is null.

omitEnd

public boolean omitEnd()
True is this element need not to have the starting tag, false otherwise.s element need not to have the closing tag, false otherwise. The HTML 4.0 definition specifies that some elements (like <hr>are not required to have the end tags.

omitStart

public boolean omitStart()
True is this element need not to have the closing tag, false otherwise. The HTML 4.0 definition specifies that some elements (like <head> or <body>) are not required to have the start tags.

toString

public String toString()
Returns the name of this element.
Overrides:
toString in interface Object

Element.java -- Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.