java.lang.Object
javax.swing.text.html.parser.Entity
- All Implemented Interfaces:
DTDConstants
public final class Entity extends Object implements DTDConstants
An entity is described in a DTD using the ENTITY construct.
It defines the type and value of the entity.
- See Also:
DTD
-
Field Summary
Fields Modifier and Type Field Description char[]
data
The char array of data.String
name
The name of the entity.int
type
The type of the entity.Fields declared in 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
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description char[]
getData()
Returns thedata
.String
getName()
Gets the name of the entity.String
getString()
Returns the data as aString
.int
getType()
Gets the type of the entity.boolean
isGeneral()
Returnstrue
if it is a general entity.boolean
isParameter()
Returnstrue
if it is a parameter entity.static int
name2type(String nm)
Convertsnm
string to the corresponding entity type.
-
Field Details
-
name
The name of the entity. -
type
public int typeThe type of the entity. -
data
public char[] dataThe char array of data.
-
-
Constructor Details
-
Entity
Creates an entity.- Parameters:
name
- the name of the entitytype
- the type of the entitydata
- the char array of data
-
-
Method Details
-
getName
Gets the name of the entity.- Returns:
- the name of the entity, as a
String
-
getType
public int getType()Gets the type of the entity.- Returns:
- the type of the entity
-
isParameter
public boolean isParameter()Returnstrue
if it is a parameter entity.- Returns:
true
if it is a parameter entity
-
isGeneral
public boolean isGeneral()Returnstrue
if it is a general entity.- Returns:
true
if it is a general entity
-
getData
public char[] getData()Returns thedata
.- Returns:
- the
data
-
getString
Returns the data as aString
.- Returns:
- the data as a
String
-
name2type
Convertsnm
string to the corresponding entity type. If the string does not have a corresponding entity type, returns the type corresponding to "CDATA". Valid entity types are: "PUBLIC", "CDATA", "SDATA", "PI", "STARTTAG", "ENDTAG", "MS", "MD", "SYSTEM".- Parameters:
nm
- the string to be converted- Returns:
- the corresponding entity type, or the type corresponding to "CDATA", if none exists
-