/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */


package com.sun.jdo.api.persistence.enhancer.classfile;

import java.io.*;

/**
 * Class representing a class specification in the constant pool
 */

/*
   ConstString strictly speaking is not a ConstantValue in the
   Java VM sense.  However, the compiler generates ConstantValue attributes
   which refer to ConstString entries.  This occurs for initialized static
   final String fields.  I've changed ConstString to be a ConstValue for 
   now as a simplification.
*/

public class ConstString extends ConstValue {
  /* The tag associated with ConstClass entries */
  public static final int MyTag = CONSTANTString;

  /* The name of the class being referred to */
  private ConstUtf8 stringValue;

  /* The index of name of the class being referred to
   *  - used while reading from a class file */
  private int stringValueIndex;

  /* public accessors */

  /**
   * Return the tag for this constant
   */
  public int tag () { return MyTag; }

  /**
   * Return the utf8 string calue
   */
  public ConstUtf8 value() {
    return stringValue;
  }

  /**
   * Return the descriptor string for the constant type.
   */
  public String descriptor() {
      return "Ljava/lang/String;";//NOI18N
  }

  /**
   * A printable representation 
   */
  public String toString () {
      return "CONSTANTString(" + indexAsString() + "): " + //NOI18N
          "string(" + stringValue.asString() + ")";//NOI18N
  }

  /* package local methods */

  ConstString (ConstUtf8 s) {
    stringValue = s;
  }

  ConstString (int sIndex) {
    stringValueIndex = sIndex;
  }

  void formatData (DataOutputStream b) throws IOException {
    b.writeShort (stringValue.getIndex());
  }
  static ConstString read (DataInputStream input) throws IOException {
    return new ConstString (input.readUnsignedShort());
  }
  void resolve (ConstantPool p) {
    stringValue = (ConstUtf8) p.constantAt(stringValueIndex);
  }
}