001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 *  Unless required by applicable law or agreed to in writing, software
012 *  distributed under the License is distributed on an "AS IS" BASIS,
013 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 *  See the License for the specific language governing permissions and
015 *  limitations under the License.
016 *
017 */
018package org.apache.bcel.classfile;
019
020import java.io.DataInput;
021import java.io.DataOutputStream;
022import java.io.IOException;
023
024import org.apache.bcel.Const;
025
026/**
027 * This class is derived from the abstract {@link Constant} and represents a reference to a String object.
028 *
029 * @see Constant
030 */
031public final class ConstantString extends Constant implements ConstantObject {
032
033    private int stringIndex; // Identical to ConstantClass except for this name
034
035    /**
036     * Initialize from another object.
037     */
038    public ConstantString(final ConstantString c) {
039        this(c.getStringIndex());
040    }
041
042    /**
043     * Initialize instance from file data.
044     *
045     * @param file Input stream
046     * @throws IOException if an I/O error occurs.
047     */
048    ConstantString(final DataInput file) throws IOException {
049        this(file.readUnsignedShort());
050    }
051
052    /**
053     * @param stringIndex Index of Constant_Utf8 in constant pool
054     */
055    public ConstantString(final int stringIndex) {
056        super(Const.CONSTANT_String);
057        this.stringIndex = stringIndex;
058    }
059
060    /**
061     * Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class.
062     * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree of objects.
063     *
064     * @param v Visitor object
065     */
066    @Override
067    public void accept(final Visitor v) {
068        v.visitConstantString(this);
069    }
070
071    /**
072     * Dump constant field reference to file stream in binary format.
073     *
074     * @param file Output file stream
075     * @throws IOException if an I/O error occurs.
076     */
077    @Override
078    public void dump(final DataOutputStream file) throws IOException {
079        file.writeByte(super.getTag());
080        file.writeShort(stringIndex);
081    }
082
083    /**
084     * @return dereferenced string
085     */
086    public String getBytes(final ConstantPool cp) {
087        return (String) getConstantValue(cp);
088    }
089
090    /**
091     * @return String object
092     */
093    @Override
094    public Object getConstantValue(final ConstantPool cp) {
095        return cp.getConstantUtf8(stringIndex).getBytes();
096    }
097
098    /**
099     * @return Index in constant pool of the string (ConstantUtf8).
100     */
101    public int getStringIndex() {
102        return stringIndex;
103    }
104
105    /**
106     * @param stringIndex the index into the constant of the string value
107     */
108    public void setStringIndex(final int stringIndex) {
109        this.stringIndex = stringIndex;
110    }
111
112    /**
113     * @return String representation.
114     */
115    @Override
116    public String toString() {
117        return super.toString() + "(stringIndex = " + stringIndex + ")";
118    }
119}