1 /*******************************************************************************
2 * Copyright (c) 2000, 2008 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
9 * IBM Corporation - initial API and implementation
10 *******************************************************************************/
11 package net.sourceforge.phpdt.core;
13 import org.eclipse.core.runtime.IProgressMonitor;
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
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.
29 * @see IPackageFragmentRoot#attachSource(org.eclipse.core.runtime.IPath, org.eclipse.core.runtime.IPath, IProgressMonitor)
30 * @noimplement This interface is not intended to be implemented by clients.
33 public interface IClassFile extends ITypeRoot {
36 * Changes this class file handle into a working copy. A new {@link IBuffer} is
37 * created using the given owner. Uses the primary owner if <code>null</code> is
40 * When switching to working copy mode, problems are reported to the given
41 * {@link IProblemRequestor}. Note that once in working copy mode, the given
42 * {@link IProblemRequestor} is ignored. Only the original {@link IProblemRequestor}
43 * is used to report subsequent problems.
46 * Once in working copy mode, changes to this working copy or its children are done in memory.
47 * Only the new buffer is affected.
50 * Using {@link ICompilationUnit#commitWorkingCopy(boolean, IProgressMonitor)} on the working copy
51 * will throw a <code>JavaModelException</code> as a class file is implicetly read-only.
54 * If this class file was already in working copy mode, an internal counter is incremented and no
55 * other action is taken on this working copy. To bring this working copy back into the original mode
56 * (where it reflects the underlying resource), {@link ICompilationUnit#discardWorkingCopy} must be call as many
57 * times as {@link #becomeWorkingCopy(IProblemRequestor, WorkingCopyOwner, IProgressMonitor)}.
60 * The primary compilation unit of a class file's working copy does not exist if the class file is not
61 * in working copy mode (<code>classFileWorkingCopy.getPrimary().exists() == false</code>).
64 * The resource of a class file's working copy is <code>null</code> if the class file is in an external jar file.
67 * @param problemRequestor a requestor which will get notified of problems detected during
68 * reconciling as they are discovered. The requestor can be set to <code>null</code> indicating
69 * that the client is not interested in problems.
70 * @param owner the given {@link WorkingCopyOwner}, or <code>null</code> for the primary owner
71 * @param monitor a progress monitor used to report progress while opening this compilation unit
72 * or <code>null</code> if no progress should be reported
73 * @return a working copy for this class file
74 * @throws JavaModelException if this compilation unit could not become a working copy.
75 * @see ICompilationUnit#discardWorkingCopy()
77 * @deprecated Use {@link ITypeRoot#getWorkingCopy(WorkingCopyOwner, IProgressMonitor)} instead.
78 * Note that if this deprecated method is used, problems will be reported to the given problem requestor
79 * as well as the problem requestor returned by the working copy owner (if not null).
81 ICompilationUnit becomeWorkingCopy(IProblemRequestor problemRequestor, WorkingCopyOwner owner, IProgressMonitor monitor) throws JavaModelException;
83 * Returns the bytes contained in this class file.
85 * @return the bytes contained in this class file
87 * @exception JavaModelException if this element does not exist or if an
88 * exception occurs while accessing its corresponding resource
91 byte[] getBytes() throws JavaModelException;
93 * Returns the type contained in this class file.
94 * This is a handle-only method. The type may or may not exist.
96 * @return the type contained in this class file
100 * Returns a working copy on the source associated with this class file using the given
101 * factory to create the buffer, or <code>null</code> if there is no source associated
102 * with the class file.
104 * The buffer will be automatically initialized with the source of the class file
107 * The only valid operations on this working copy are <code>getBuffer()</code> or <code>getOriginalElement</code>.
109 * @param monitor a progress monitor used to report progress while opening this compilation unit
110 * or <code>null</code> if no progress should be reported
111 * @param factory the factory that creates a buffer that is used to get the content of the working copy
112 * or <code>null</code> if the internal factory should be used
113 * @return a a working copy on the source associated with this class file
114 * @exception JavaModelException if the source of this class file can
115 * not be determined. Reasons include:
117 * <li> This class file does not exist (ELEMENT_DOES_NOT_EXIST)</li>
120 * @deprecated Use {@link ITypeRoot#getWorkingCopy(WorkingCopyOwner, IProgressMonitor)} instead
122 IJavaElement getWorkingCopy(IProgressMonitor monitor, IBufferFactory factory) throws JavaModelException;
124 * Returns whether this type represents a class. This is not guaranteed to be
125 * instantaneous, as it may require parsing the underlying file.
127 * @return <code>true</code> if the class file represents a class.
129 * @exception JavaModelException if this element does not exist or if an
130 * exception occurs while accessing its corresponding resource
132 boolean isClass() throws JavaModelException;
134 * Returns whether this type represents an interface. This is not guaranteed to
135 * be instantaneous, as it may require parsing the underlying file.
137 * @return <code>true</code> if the class file represents an interface.
139 * @exception JavaModelException if this element does not exist or if an
140 * exception occurs while accessing its corresponding resource
142 boolean isInterface() throws JavaModelException;