javax.swing.text.html.parser
Class Entity

java.lang.Object
  extended by javax.swing.text.html.parser.Entity
All Implemented Interfaces:
DTDConstants

public final class Entity
extends Object
implements DTDConstants

Stores information, obtained by parsing SGML DTL <!ENTITY % .. > tag.

The entity defines some kind of macro that can be used elsewhere in the document. When the macro is referred to by the name in the DTD, it is expanded into a string


Field Summary
 char[] data
          The entity data
 String name
          The entity name.
 int type
          The entity type.
 
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
Entity(String a_name, int a_type, char[] a_data)
          Create a new entity
 
Method Summary
 char[] getData()
          Get the entity data.
 String getName()
          Get the entity name.
 String getString()
          Returns a data as String
 int getType()
          Get the entity type.
 boolean isGeneral()
          Returns true for general entities.
 boolean isParameter()
          Returns true for parameter entities.
static int name2type(String an_entity)
          Converts a given string to the corresponding entity type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

public String name
The entity name.


data

public char[] data
The entity data


type

public int type
The entity type.

Constructor Detail

Entity

public Entity(String a_name,
              int a_type,
              char[] a_data)
Create a new entity

Parameters:
a_name - the entity name
a_type - the entity type
a_data - the data replacing the entity reference
Method Detail

name2type

public static int name2type(String an_entity)
Converts a given string to the corresponding entity type.

Returns:
a value, defined in DTDConstants (one of PUBLIC, CDATA, SDATA, PI, STARTTAG, ENDTAG, MS, MD, SYSTEM) or CDATA if the parameter is not a valid entity type.

getData

public char[] getData()
Get the entity data.


isGeneral

public boolean isGeneral()
Returns true for general entities. Each general entity can be referenced as &entity-name;. Such entities are defined by the SGML DTD tag <!ENTITY name "value">. The general entities can be used anywhere in the document.


getName

public String getName()
Get the entity name.


isParameter

public boolean isParameter()
Returns true for parameter entities. Each parameter entity can be referenced as &entity-name;. Such entities are defined by the SGML DTD tag <!ENTITY % name "value">. The parameter entities can be used only in SGML context.


getString

public String getString()
Returns a data as String


getType

public int getType()
Get the entity type.

Returns:
the value of the type.