src/main/java/org/apache/bcel/generic/ClassElementValueGen.java

/*
 * 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
 *
 *   https://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 org.apache.bcel.generic;

import java.io.DataOutputStream;
import java.io.IOException;

import org.apache.bcel.classfile.ClassElementValue;
import org.apache.bcel.classfile.ConstantUtf8;
import org.apache.bcel.classfile.ElementValue;

/**
 * Generates class element values in annotations.
 *
 * @since 6.0
 */
public class ClassElementValueGen extends ElementValueGen {
    // For primitive types and string type, this points to the value entry in
    // the cpool
    // For 'class' this points to the class entry in the cpool
    private final int idx;

    /**
     * Constructs a ClassElementValueGen.
     *
     * @param value the class element value.
     * @param cpool the constant pool generator.
     * @param copyPoolEntries whether to copy pool entries.
     */
    public ClassElementValueGen(final ClassElementValue value, final ConstantPoolGen cpool, final boolean copyPoolEntries) {
        super(CLASS, cpool);
        if (copyPoolEntries) {
            // idx = cpool.addClass(value.getClassString());
            idx = cpool.addUtf8(value.getClassString());
        } else {
            idx = value.getIndex();
        }
    }

    /**
     * Constructs a ClassElementValueGen.
     *
     * @param typeIdx the type index.
     * @param cpool the constant pool generator.
     */
    protected ClassElementValueGen(final int typeIdx, final ConstantPoolGen cpool) {
        super(CLASS, cpool);
        this.idx = typeIdx;
    }

    /**
     * Constructs a ClassElementValueGen.
     *
     * @param t the object type.
     * @param cpool the constant pool generator.
     */
    public ClassElementValueGen(final ObjectType t, final ConstantPoolGen cpool) {
        super(CLASS, cpool);
        // this.idx = cpool.addClass(t);
        idx = cpool.addUtf8(t.getSignature());
    }

    @Override
    public void dump(final DataOutputStream dos) throws IOException {
        dos.writeByte(super.getElementValueType()); // u1 kind of value
        dos.writeShort(idx);
    }

    /**
     * Gets the class string.
     *
     * @return the class string.
     */
    public String getClassString() {
        final ConstantUtf8 cu8 = (ConstantUtf8) getConstantPool().getConstant(idx);
        return cu8.getBytes();
        // ConstantClass c = (ConstantClass) getConstantPool().getConstant(idx);
        // ConstantUtf8 utf8 =
        // (ConstantUtf8) getConstantPool().getConstant(c.getNameIndex());
        // return utf8.getBytes();
    }

    /**
     * Return immutable variant of this ClassElementValueGen.
     *
     * @return immutable variant of this ClassElementValueGen.
     */
    @Override
    public ElementValue getElementValue() {
        return new ClassElementValue(super.getElementValueType(), idx, getConstantPool().getConstantPool());
    }

    /**
     * Gets the index.
     *
     * @return the index.
     */
    public int getIndex() {
        return idx;
    }

    @Override
    public String stringifyValue() {
        return getClassString();
    }
}