/*

 */

/*

 * Licensed to the Apache Software Foundation (ASF) under one or more

 * contributor license agreements.  See the NOTICE file distributed with

 * this work for additional information regarding copyright ownership.

 * The ASF licenses this file to You under the Apache License, Version 2.0

 * (the "License"); you may not use this file except in compliance with

 * the License.  You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

package com.sun.org.apache.bcel.internal.classfile;

import java.io.DataInput;

import java.io.DataOutputStream;

import java.io.IOException;

import com.sun.org.apache.bcel.internal.Const;

import com.sun.org.apache.bcel.internal.util.BCELComparator;

/**

 *

 */

public abstract class Constant implements Cloneable, Node {

    private static BCELComparator bcelComparator = new BCELComparator() {

        @Override

            final Constant THIS = (Constant) o1;

            final Constant THAT = (Constant) o2;

        }

        @Override

            final Constant THIS = (Constant) o;

            return THIS.toString().hashCode();

        }

    };

    /* In fact this tag is redundant since we can distinguish different

     * `Constant' objects by their type, i.e., via `instanceof'. In some

     * places we will use the tag for switch()es anyway.

     *

     * First, we want match the specification as closely as possible. Second we

     * need the tag as an index to select the corresponding class name from the

     * `CONSTANT_NAMES' array.

     */

    private byte tag;

    Constant(final byte tag) {

        this.tag = tag;

    }

    /**

     * Called by objects that are traversing the nodes of the tree implicitely

     * defined by the contents of a Java class. I.e., the hierarchy of methods,

     * fields, attributes, etc. spawns a tree of objects.

     *

     * @param v Visitor object

     */

    @Override

    /**

     * @return Tag of constant, i.e., its type. No setTag() method to avoid

     * confusion.

     */

    public final byte getTag() {

        return tag;

    }

    /**

     * @return String representation.

     */

    @Override

    public String toString() {

        return Const.getConstantName(tag) + "[" + tag + "]";

    }

    /**

     * @return deep copy of this constant

     */

    public Constant copy() {

        try {

            return (Constant) super.clone();

        } catch (final CloneNotSupportedException e) {

            // TODO should this throw?

        }

        return null;

    }

    @Override

    public Object clone() {

        try {

            return super.clone();

        } catch (final CloneNotSupportedException e) {

            throw new Error("Clone Not Supported"); // never happens

        }

    }

    /**

     * Read one constant from the given input, the type depends on a tag byte.

     *

     * @return Constant object

     * @since 6.0 made public

     */

        switch (b) {

        }

    }

    /**

     * @return Comparison strategy object

     */

    public static BCELComparator getComparator() {

        return bcelComparator;

    }

    /**

     * @param comparator Comparison strategy object

     */

        bcelComparator = comparator;

    }

    /**

     *

     * @see java.lang.Object#equals(java.lang.Object)

     */

    @Override

        return bcelComparator.equals(this, obj);

    }

    /**

     *

     * @see java.lang.Object#hashCode()

     */

    @Override

    public int hashCode() {

        return bcelComparator.hashCode(this);

    }

}