javax.swing.text.html.parser
Class Entity
- 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 the entity.- See Also:
-
DTD
-
-
Field Summary
Fields Modifier and Type Field and Description char[]dataStringnameinttype-
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
-
-
Constructor Summary
Constructors Constructor and Description Entity(String name, int type, char[] data)Creates an entity.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description char[]getData()Returns thedata.StringgetName()Gets the name of the entity.StringgetString()Returns the data as aString.intgetType()Gets the type of the entity.booleanisGeneral()Returnstrueif it is a general entity.booleanisParameter()Returnstrueif it is a parameter entity.static intname2type(String nm)Convertsnmstring to the corresponding entity type.
-
-
-
Field Detail
name
public String name
type
public int type
data
public char[] data
-
Constructor Detail
Entity
public Entity(String name, int type, char[] data)
Creates an entity.- Parameters:
-
name- the name of the entity -
type- the type of the entity -
data- the char array of data
-
Method Detail
getName
public String 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()
Returnstrueif it is a parameter entity.- Returns:
-
trueif it is a parameter entity
isGeneral
public boolean isGeneral()
Returnstrueif it is a general entity.- Returns:
-
trueif it is a general entity
getData
public char[] getData()
Returns thedata.- Returns:
-
the
data
getString
public String getString()
Returns the data as aString.- Returns:
-
the data as a
String
name2type
public static int name2type(String nm)
Convertsnmstring 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
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
