1 /* 2 * reserved comment block 3 * DO NOT REMOVE OR ALTER! 4 */ 5 /* 6 * Licensed to the Apache Software Foundation (ASF) under one or more 7 * contributor license agreements. See the NOTICE file distributed with 8 * this work for additional information regarding copyright ownership. 9 * The ASF licenses this file to You under the Apache License, Version 2.0 10 * (the "License"); you may not use this file except in compliance with 11 * the License. You may obtain a copy of the License at 12 * 13 * http://www.apache.org/licenses/LICENSE-2.0 14 * 15 * Unless required by applicable law or agreed to in writing, software 16 * distributed under the License is distributed on an "AS IS" BASIS, 17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 18 * See the License for the specific language governing permissions and 19 * limitations under the License. 20 */ 21 22 package com.sun.org.apache.bcel.internal.classfile; 23 24 25 import com.sun.org.apache.bcel.internal.Constants; 26 import java.io.*; 27 28 /** 29 * This class is derived from <em>Attribute</em> and represents a reference 30 * to the source file of this class. At most one SourceFile attribute 31 * should appear per classfile. The intention of this class is that it is 32 * instantiated from the <em>Attribute.readAttribute()</em> method. 33 * 34 * @author <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A> 35 * @see Attribute 36 */ 37 public final class SourceFile extends Attribute { 38 private int sourcefile_index; 39 40 /** 41 * Initialize from another object. Note that both objects use the same 42 * references (shallow copy). Use clone() for a physical copy. 43 */ 44 public SourceFile(SourceFile c) { 45 this(c.getNameIndex(), c.getLength(), c.getSourceFileIndex(), 46 c.getConstantPool()); 47 } 48 49 /** 50 * Construct object from file stream. 51 * @param name_index Index in constant pool to CONSTANT_Utf8 52 * @param length Content length in bytes 53 * @param file Input stream 54 * @param constant_pool Array of constants 55 * @throws IOException 56 */ 57 SourceFile(int name_index, int length, DataInputStream file, 58 ConstantPool constant_pool) throws IOException 59 { 60 this(name_index, length, file.readUnsignedShort(), constant_pool); 61 } 62 63 /** 64 * @param name_index Index in constant pool to CONSTANT_Utf8, which 65 * should represent the string "SourceFile". 66 * @param length Content length in bytes, the value should be 2. 67 * @param constant_pool The constant pool that this attribute is 68 * associated with. 69 * @param sourcefile_index Index in constant pool to CONSTANT_Utf8. This 70 * string will be interpreted as the name of the file from which this 71 * class was compiled. It will not be interpreted as indicating the name 72 * of the directory contqining the file or an absolute path; this 73 * information has to be supplied the consumer of this attribute - in 74 * many cases, the JVM. 75 */ 76 public SourceFile(int name_index, int length, int sourcefile_index, 77 ConstantPool constant_pool) 78 { 79 super(Constants.ATTR_SOURCE_FILE, name_index, length, constant_pool); 80 this.sourcefile_index = sourcefile_index; 81 } 82 83 /** 84 * Called by objects that are traversing the nodes of the tree implicitely 85 * defined by the contents of a Java class. I.e., the hierarchy of methods, 86 * fields, attributes, etc. spawns a tree of objects. 87 * 88 * @param v Visitor object 89 */ 90 public void accept(Visitor v) { 91 v.visitSourceFile(this); 92 } 93 94 /** 95 * Dump source file attribute to file stream in binary format. 96 * 97 * @param file Output file stream 98 * @throws IOException 99 */ 100 public final void dump(DataOutputStream file) throws IOException 101 { 102 super.dump(file); 103 file.writeShort(sourcefile_index); 104 } 105 106 /** 107 * @return Index in constant pool of source file name. 108 */ 109 public final int getSourceFileIndex() { return sourcefile_index; } 110 111 /** 112 * @param sourcefile_index. 113 */ 114 public final void setSourceFileIndex(int sourcefile_index) { 115 this.sourcefile_index = sourcefile_index; 116 } 117 118 /** 119 * @return Source file name. 120 */ 121 public final String getSourceFileName() { 122 ConstantUtf8 c = (ConstantUtf8)constant_pool.getConstant(sourcefile_index, 123 Constants.CONSTANT_Utf8); 124 return c.getBytes(); 125 } 126 127 /** 128 * @return String representation 129 */ 130 public final String toString() { 131 return "SourceFile(" + getSourceFileName() + ")"; 132 } 133 134 /** 135 * @return deep copy of this attribute 136 */ 137 public Attribute copy(ConstantPool constant_pool) { 138 return (SourceFile)clone(); 139 } 140 }