KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > bcel > internal > classfile > SourceFile


1 package com.sun.org.apache.bcel.internal.classfile;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2001 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution,
22  * if any, must include the following acknowledgment:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgment may appear in the software itself,
26  * if and wherever such third-party acknowledgments normally appear.
27  *
28  * 4. The names "Apache" and "Apache Software Foundation" and
29  * "Apache BCEL" must not be used to endorse or promote products
30  * derived from this software without prior written permission. For
31  * written permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache",
34  * "Apache BCEL", nor may "Apache" appear in their name, without
35  * prior written permission of the Apache Software Foundation.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  */
56
57 import com.sun.org.apache.bcel.internal.Constants;
58 import java.io.*;
59
60 /**
61  * This class is derived from <em>Attribute</em> and represents a reference
62  * to the source file of this class.
63  * It is instantiated from the <em>Attribute.readAttribute()</em> method.
64  *
65  * @version $Id: SourceFile.java,v 1.1.1.1 2001/10/29 20:00:03 jvanzyl Exp $
66  * @author <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A>
67  * @see Attribute
68  */
69 public final class SourceFile extends Attribute {
70   private int sourcefile_index;
71
72   /**
73    * Initialize from another object. Note that both objects use the same
74    * references (shallow copy). Use clone() for a physical copy.
75    */
76   public SourceFile(SourceFile c) {
77     this(c.getNameIndex(), c.getLength(), c.getSourceFileIndex(),
78      c.getConstantPool());
79   }
80
81   /**
82    * Construct object from file stream.
83    * @param name_index Index in constant pool to CONSTANT_Utf8
84    * @param length Content length in bytes
85    * @param file Input stream
86    * @param constant_pool Array of constants
87    * @throw IOException
88    */
89   SourceFile(int name_index, int length, DataInputStream file,
90          ConstantPool constant_pool) throws IOException
91   {
92     this(name_index, length, file.readUnsignedShort(), constant_pool);
93   }
94
95   /**
96    * @param name_index Index in constant pool to CONSTANT_Utf8
97    * @param length Content length in bytes
98    * @param constant_pool Array of constants
99    * @param sourcefile_index Index in constant pool to CONSTANT_Utf8
100    */
101   public SourceFile(int name_index, int length, int sourcefile_index,
102             ConstantPool constant_pool)
103   {
104     super(Constants.ATTR_SOURCE_FILE, name_index, length, constant_pool);
105     this.sourcefile_index = sourcefile_index;
106   }
107
108   /**
109    * Called by objects that are traversing the nodes of the tree implicitely
110    * defined by the contents of a Java class. I.e., the hierarchy of methods,
111    * fields, attributes, etc. spawns a tree of objects.
112    *
113    * @param v Visitor object
114    */
115   public void accept(Visitor v) {
116     v.visitSourceFile(this);
117   }
118
119   /**
120    * Dump source file attribute to file stream in binary format.
121    *
122    * @param file Output file stream
123    * @throw IOException
124    */
125   public final void dump(DataOutputStream file) throws IOException
126   {
127     super.dump(file);
128     file.writeShort(sourcefile_index);
129   }
130
131   /**
132    * @return Index in constant pool of source file name.
133    */
134   public final int getSourceFileIndex() { return sourcefile_index; }
135
136   /**
137    * @param sourcefile_index.
138    */
139   public final void setSourceFileIndex(int sourcefile_index) {
140     this.sourcefile_index = sourcefile_index;
141   }
142
143   /**
144    * @return Source file name.
145    */
146   public final String JavaDoc getSourceFileName() {
147     ConstantUtf8 c = (ConstantUtf8)constant_pool.getConstant(sourcefile_index,
148                                  Constants.CONSTANT_Utf8);
149     return c.getBytes();
150   }
151
152   /**
153    * @return String representation
154    */
155   public final String JavaDoc toString() {
156     return "SourceFile(" + getSourceFileName() + ")";
157   }
158
159   /**
160    * @return deep copy of this attribute
161    */
162   public Attribute copy(ConstantPool constant_pool) {
163     return (SourceFile)clone();
164   }
165 }
166
Popular Tags