Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.swing.text.html.parser

Class Entity

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, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

data

public char[] data
The entity data

name

public String name
The entity name.

type

public int type
The entity type.

Constructor Details

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 Details

getData

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

getName

public String getName()
Get the entity name.

getString

public String getString()
Returns a data as String

getType

public int getType()
Get the entity type.
Returns:
the value of the type.

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.

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.

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.
Entity.java -- Stores information, obtained by parsing SGML DTL * <!ENTITY % .. > tag 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.

Overview Package Class Use Source Tree Index Deprecated About