KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > core > IClassFile


1 /*******************************************************************************
2  * Copyright (c) 2000, 2007 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.jdt.core;
12
13 import org.eclipse.core.runtime.IProgressMonitor;
14
15 /**
16  * Represents an entire binary type (single <code>.class</code> file).
17  * A class file has a single child of type <code>IType</code>.
18  * Class file elements need to be opened before they can be navigated.
19  * If a class file cannot be parsed, its structure remains unknown. Use
20  * <code>IJavaElement.isStructureKnown</code> to determine whether this is the
21  * case.
22  * <p>
23  * Note: <code>IClassFile</code> extends <code>ISourceReference</code>.
24  * Source can be obtained for a class file if and only if source has been attached to this
25  * class file. The source associated with a class file is the source code of
26  * the compilation unit it was (nominally) generated from.
27  * </p>
28  * <p>
29  * This interface is not intended to be implemented by clients.
30  * </p>
31  *
32  * @see IPackageFragmentRoot#attachSource(org.eclipse.core.runtime.IPath, org.eclipse.core.runtime.IPath, IProgressMonitor)
33  */
34
35 public interface IClassFile extends ITypeRoot {
36
37 /**
38  * Changes this class file handle into a working copy. A new {@link IBuffer} is
39  * created using the given owner. Uses the primary owner if <code>null</code> is
40  * specified.
41  * <p>
42  * When switching to working copy mode, problems are reported to the given
43  * {@link IProblemRequestor}. Note that once in working copy mode, the given
44  * {@link IProblemRequestor} is ignored. Only the original {@link IProblemRequestor}
45  * is used to report subsequent problems.
46  * </p>
47  * <p>
48  * Once in working copy mode, changes to this working copy or its children are done in memory.
49  * Only the new buffer is affected.
50  * </p>
51  * <p>
52  * Using {@link ICompilationUnit#commitWorkingCopy(boolean, IProgressMonitor)} on the working copy
53  * will throw a <code>JavaModelException</code> as a class file is implicetly read-only.
54  * </p>
55  * <p>
56  * If this class file was already in working copy mode, an internal counter is incremented and no
57  * other action is taken on this working copy. To bring this working copy back into the original mode
58  * (where it reflects the underlying resource), {@link ICompilationUnit#discardWorkingCopy} must be call as many
59  * times as {@link #becomeWorkingCopy(IProblemRequestor, WorkingCopyOwner, IProgressMonitor)}.
60  * </p>
61  * <p>
62  * The primary compilation unit of a class file's working copy does not exist if the class file is not
63  * in working copy mode (<code>classFileWorkingCopy.getPrimary().exists() == false</code>).
64  * </p>
65  * <p>
66  * The resource of a class file's working copy is <code>null</code> if the class file is in an external jar file.
67  * </p>
68  *
69  * @param problemRequestor a requestor which will get notified of problems detected during
70  * reconciling as they are discovered. The requestor can be set to <code>null</code> indicating
71  * that the client is not interested in problems.
72  * @param owner the given {@link WorkingCopyOwner}, or <code>null</code> for the primary owner
73  * @param monitor a progress monitor used to report progress while opening this compilation unit
74  * or <code>null</code> if no progress should be reported
75  * @return a working copy for this class file
76  * @throws JavaModelException if this compilation unit could not become a working copy.
77  * @see ICompilationUnit#discardWorkingCopy()
78  * @since 3.2
79  * @deprecated Use {@link ITypeRoot#getWorkingCopy(WorkingCopyOwner, IProgressMonitor)} instead.
80  * Note that if this deprecated method is used, problems will be reported to the given problem requestor
81  * as well as the problem requestor returned by the working copy owner (if not null).
82  */
83 ICompilationUnit becomeWorkingCopy(IProblemRequestor problemRequestor, WorkingCopyOwner owner, IProgressMonitor monitor) throws JavaModelException;
84 /**
85  * Returns the bytes contained in this class file.
86  *
87  * @return the bytes contained in this class file
88  *
89  * @exception JavaModelException if this element does not exist or if an
90  * exception occurs while accessing its corresponding resource
91  * @since 3.3
92  */
93 byte[] getBytes() throws JavaModelException;
94 /**
95  * Returns the type contained in this class file.
96  * This is a handle-only method. The type may or may not exist.
97  *
98  * @return the type contained in this class file
99  */
100 IType getType();
101 /**
102  * Returns a working copy on the source associated with this class file using the given
103  * factory to create the buffer, or <code>null</code> if there is no source associated
104  * with the class file.
105  * <p>
106  * The buffer will be automatically initialized with the source of the class file
107  * upon creation.
108  * <p>
109  * The only valid operations on this working copy are <code>getBuffer()</code> or <code>getOriginalElement</code>.
110  *
111  * @param monitor a progress monitor used to report progress while opening this compilation unit
112  * or <code>null</code> if no progress should be reported
113  * @param factory the factory that creates a buffer that is used to get the content of the working copy
114  * or <code>null</code> if the internal factory should be used
115  * @return a a working copy on the source associated with this class file
116  * @exception JavaModelException if the source of this class file can
117  * not be determined. Reasons include:
118  * <ul>
119  * <li> This class file does not exist (ELEMENT_DOES_NOT_EXIST)</li>
120  * </ul>
121  * @since 2.0
122  * @deprecated Use {@link ITypeRoot#getWorkingCopy(WorkingCopyOwner, IProgressMonitor)} instead
123  */
124 IJavaElement getWorkingCopy(IProgressMonitor monitor, IBufferFactory factory) throws JavaModelException;
125 /**
126  * Returns whether this type represents a class. This is not guaranteed to be
127  * instantaneous, as it may require parsing the underlying file.
128  *
129  * @return <code>true</code> if the class file represents a class.
130  *
131  * @exception JavaModelException if this element does not exist or if an
132  * exception occurs while accessing its corresponding resource
133  */
134 boolean isClass() throws JavaModelException;
135 /**
136  * Returns whether this type represents an interface. This is not guaranteed to
137  * be instantaneous, as it may require parsing the underlying file.
138  *
139  * @return <code>true</code> if the class file represents an interface.
140  *
141  * @exception JavaModelException if this element does not exist or if an
142  * exception occurs while accessing its corresponding resource
143  */
144 boolean isInterface() throws JavaModelException;
145 }
146
Popular Tags