/*

 * 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.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package javax.swing.text.html.parser;

import java.util.Hashtable;

import java.util.BitSet;

import java.io.*;

/**

 * An element as described in a DTD using the ELEMENT construct.

 * This is essentiall the description of a tag. It describes the

 * type, content model, attributes, attribute types etc. It is used

 * to correctly parse a document by the Parser.

 *

 * @see DTD

 * @see AttributeList

 * @author Arthur van Hoff

 */

public final

class Element implements DTDConstants, Serializable {

    public int index;

    public String name;

    public boolean oStart;

    public boolean oEnd;

    public BitSet inclusions;

    public BitSet exclusions;

    public int type = ANY;

    public ContentModel content;

    public AttributeList atts;

    static int maxIndex = 0;

    /**

     * A field to store user data. Mostly used to store

     * style sheets.

     */

    public Object data;

    Element() {

    }

    /**

     * Create a new element.

     */

    Element(String name, int index) {

        this.name = name;

        this.index = index;

        maxIndex = Math.max(maxIndex, index);

    }

    /**

     * Get the name of the element.

     */

    public String getName() {

        return name;

    }

    /**

     * Return true if the start tag can be omitted.

     */

    public boolean omitStart() {

        return oStart;

    }

    /**

     * Return true if the end tag can be omitted.

     */

    public boolean omitEnd() {

        return oEnd;

    }

    /**

     * Get type.

     */

    public int getType() {

        return type;

    }

    /**

     * Get content model

     */

    public ContentModel getContent() {

        return content;

    }

    /**

     * Get the attributes.

     */

    public AttributeList getAttributes() {

        return atts;

    }

    /**

     * Get index.

     */

    public int getIndex() {

        return index;

    }

    /**

     * Check if empty

     */

    public boolean isEmpty() {

        return type == EMPTY;

    }

    /**

     * Convert to a string.

     */

    public String toString() {

        return name;

    }

    /**

     * Get an attribute by name.

     */

    public AttributeList getAttribute(String name) {

        for (AttributeList a = atts ; a != null ; a = a.next) {

            if (a.name.equals(name)) {

                return a;

            }

        }

        return null;

    }

    /**

     * Get an attribute by value.

     */

    public AttributeList getAttributeByValue(String name) {

        for (AttributeList a = atts ; a != null ; a = a.next) {

            if ((a.values != null) && a.values.contains(name)) {

                return a;

            }

        }

        return null;

    }

    static Hashtable contentTypes = new Hashtable();

    static {

        contentTypes.put("CDATA", Integer.valueOf(CDATA));

        contentTypes.put("RCDATA", Integer.valueOf(RCDATA));

        contentTypes.put("EMPTY", Integer.valueOf(EMPTY));

        contentTypes.put("ANY", Integer.valueOf(ANY));

    }

    public static int name2type(String nm) {

        Integer val = (Integer)contentTypes.get(nm);

        return (val != null) ? val.intValue() : 0;

    }

}