1. package com.sun.org.apache.bcel.internal.classfile;
  2. /* ====================================================================
  3. * The Apache Software License, Version 1.1
  4. *
  5. * Copyright (c) 2001 The Apache Software Foundation. All rights
  6. * reserved.
  7. *
  8. * Redistribution and use in source and binary forms, with or without
  9. * modification, are permitted provided that the following conditions
  10. * are met:
  11. *
  12. * 1. Redistributions of source code must retain the above copyright
  13. * notice, this list of conditions and the following disclaimer.
  14. *
  15. * 2. Redistributions in binary form must reproduce the above copyright
  16. * notice, this list of conditions and the following disclaimer in
  17. * the documentation and/or other materials provided with the
  18. * distribution.
  19. *
  20. * 3. The end-user documentation included with the redistribution,
  21. * if any, must include the following acknowledgment:
  22. * "This product includes software developed by the
  23. * Apache Software Foundation (http://www.apache.org/)."
  24. * Alternately, this acknowledgment may appear in the software itself,
  25. * if and wherever such third-party acknowledgments normally appear.
  26. *
  27. * 4. The names "Apache" and "Apache Software Foundation" and
  28. * "Apache BCEL" must not be used to endorse or promote products
  29. * derived from this software without prior written permission. For
  30. * written permission, please contact apache@apache.org.
  31. *
  32. * 5. Products derived from this software may not be called "Apache",
  33. * "Apache BCEL", nor may "Apache" appear in their name, without
  34. * prior written permission of the Apache Software Foundation.
  35. *
  36. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  37. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  38. * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  39. * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  40. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  41. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  42. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  43. * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  44. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  45. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  46. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  47. * SUCH DAMAGE.
  48. * ====================================================================
  49. *
  50. * This software consists of voluntary contributions made by many
  51. * individuals on behalf of the Apache Software Foundation. For more
  52. * information on the Apache Software Foundation, please see
  53. * <http://www.apache.org/>.
  54. */
  55. import com.sun.org.apache.bcel.internal.Constants;
  56. import java.io.*;
  57. /**
  58. * This class represents the field info structure, i.e., the representation
  59. * for a variable in the class. See JVM specification for details.
  60. *
  61. * @version $Id: Field.java,v 1.1.1.1 2001/10/29 20:00:01 jvanzyl Exp $
  62. * @author <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A>
  63. */
  64. public final class Field extends FieldOrMethod {
  65. /**
  66. * Initialize from another object. Note that both objects use the same
  67. * references (shallow copy). Use clone() for a physical copy.
  68. */
  69. public Field(Field c) {
  70. super(c);
  71. }
  72. /**
  73. * Construct object from file stream.
  74. * @param file Input stream
  75. */
  76. Field(DataInputStream file, ConstantPool constant_pool)
  77. throws IOException, ClassFormatError
  78. {
  79. super(file, constant_pool);
  80. }
  81. /**
  82. * @param access_flags Access rights of field
  83. * @param name_index Points to field name in constant pool
  84. * @param signature_index Points to encoded signature
  85. * @param attributes Collection of attributes
  86. * @param constant_pool Array of constants
  87. */
  88. public Field(int access_flags, int name_index, int signature_index,
  89. Attribute[] attributes, ConstantPool constant_pool)
  90. {
  91. super(access_flags, name_index, signature_index, attributes, constant_pool);
  92. }
  93. /**
  94. * Called by objects that are traversing the nodes of the tree implicitely
  95. * defined by the contents of a Java class. I.e., the hierarchy of methods,
  96. * fields, attributes, etc. spawns a tree of objects.
  97. *
  98. * @param v Visitor object
  99. */
  100. public void accept(Visitor v) {
  101. v.visitField(this);
  102. }
  103. /**
  104. * @return constant value associated with this field (may be null)
  105. */
  106. public final ConstantValue getConstantValue() {
  107. for(int i=0; i < attributes_count; i++)
  108. if(attributes[i].getTag() == Constants.ATTR_CONSTANT_VALUE)
  109. return (ConstantValue)attributes[i];
  110. return null;
  111. }
  112. /**
  113. * Return string representation close to declaration format,
  114. * `public static final short MAX = 100', e.g..
  115. *
  116. * @return String representation of field, including the signature.
  117. */
  118. public final String toString() {
  119. String name, signature, access; // Short cuts to constant pool
  120. // Get names from constant pool
  121. access = Utility.accessToString(access_flags);
  122. access = access.equals("")? "" : (access + " ");
  123. signature = Utility.signatureToString(getSignature());
  124. name = getName();
  125. StringBuffer buf = new StringBuffer(access + signature + " " + name);
  126. ConstantValue cv = getConstantValue();
  127. if(cv != null)
  128. buf.append(" = " + cv);
  129. for(int i=0; i < attributes_count; i++) {
  130. Attribute a = attributes[i];
  131. if(!(a instanceof ConstantValue))
  132. buf.append(" [" + a.toString() + "]");
  133. }
  134. return buf.toString();
  135. }
  136. /**
  137. * @return deep copy of this field
  138. */
  139. public final Field copy(ConstantPool constant_pool) {
  140. return (Field)copy_(constant_pool);
  141. }
  142. }