/*
 * Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.swing.text.html.parser;

import java.util.Hashtable;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.CharArrayReader;
import java.net.URL;

An entity is described in a DTD using the ENTITY construct. It defines the type and value of the entity.
Author:Arthur van Hoff
See Also:
  • DTD
/** * An entity is described in a DTD using the ENTITY construct. * It defines the type and value of the entity. * * @see DTD * @author Arthur van Hoff */
public final class Entity implements DTDConstants {
The name of the entity.
/** * The name of the entity. */
public String name;
The type of the entity.
/** * The type of the entity. */
public int type;
The char array of data.
/** * The char array of data. */
public char[] data;
Creates an entity.
Params:
  • name – the name of the entity
  • type – the type of the entity
  • data – the char array of data
/** * Creates an entity. * @param name the name of the entity * @param type the type of the entity * @param data the char array of data */
public Entity(String name, int type, char[] data) { this.name = name; this.type = type; this.data = data; }
Gets the name of the entity.
Returns:the name of the entity, as a String
/** * Gets the name of the entity. * @return the name of the entity, as a <code>String</code> */
public String getName() { return name; }
Gets the type of the entity.
Returns:the type of the entity
/** * Gets the type of the entity. * @return the type of the entity */
public int getType() { return type & 0xFFFF; }
Returns true if it is a parameter entity.
Returns:true if it is a parameter entity
/** * Returns <code>true</code> if it is a parameter entity. * @return <code>true</code> if it is a parameter entity */
public boolean isParameter() { return (type & PARAMETER) != 0; }
Returns true if it is a general entity.
Returns:true if it is a general entity
/** * Returns <code>true</code> if it is a general entity. * @return <code>true</code> if it is a general entity */
public boolean isGeneral() { return (type & GENERAL) != 0; }
Returns the data.
Returns:the data
/** * Returns the <code>data</code>. * @return the <code>data</code> */
public char[] getData() { return data; }
Returns the data as a String.
Returns:the data as a String
/** * Returns the data as a <code>String</code>. * @return the data as a <code>String</code> */
public String getString() { return new String(data, 0, data.length); } static Hashtable<String, Integer> entityTypes = new Hashtable<String, Integer>(); static { entityTypes.put("PUBLIC", Integer.valueOf(PUBLIC)); entityTypes.put("CDATA", Integer.valueOf(CDATA)); entityTypes.put("SDATA", Integer.valueOf(SDATA)); entityTypes.put("PI", Integer.valueOf(PI)); entityTypes.put("STARTTAG", Integer.valueOf(STARTTAG)); entityTypes.put("ENDTAG", Integer.valueOf(ENDTAG)); entityTypes.put("MS", Integer.valueOf(MS)); entityTypes.put("MD", Integer.valueOf(MD)); entityTypes.put("SYSTEM", Integer.valueOf(SYSTEM)); }
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".
Params:
  • nm – the string to be converted
Returns:the corresponding entity type, or the type corresponding to "CDATA", if none exists
/** * Converts <code>nm</code> 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". * * @param nm the string to be converted * @return the corresponding entity type, or the type corresponding * to "CDATA", if none exists */
public static int name2type(String nm) { Integer i = entityTypes.get(nm); return (i == null) ? CDATA : i.intValue(); } }