W3cubDocs

/OpenJDK 21

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 entity.
See Also:

Field Summary

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

Constructor Description
Entity(String name, int type, char[] data)
Creates an entity.

Method Summary

Modifier and Type Method Description
char[] getData()
Returns the data.
String getName()
Gets the name of the entity.
String getString()
Returns the data as a String.
int getType()
Gets the type of the entity.
boolean isGeneral()
Returns true if it is a general entity.
boolean isParameter()
Returns true if it is a parameter entity.
static int name2type(String nm)
Converts nm string to the corresponding entity type.

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

name

public String name
The name of the entity.

type

public int type
The type of the entity.

data

public char[] data
The char array of data.

Constructor Details

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 Details

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()
Returns true if it is a parameter entity.
Returns:
true if it is a parameter entity

isGeneral

public boolean isGeneral()
Returns true if it is a general entity.
Returns:
true if it is a general entity

getData

public char[] getData()
Returns the data.
Returns:
the data

getString

public String getString()
Returns the data as a String.
Returns:
the data as a String

name2type

public static int name2type(String nm)
Converts nm 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

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/text/html/parser/Entity.html