/*******************************************************************************
* Copyright (c) 2000, 2006 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package net.sourceforge.c4jplugin.internal.ui.contracthierarchy;
//import java.io.OutputStream;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jdt.core.Flags;
import org.eclipse.jdt.core.IType;
import org.eclipse.jdt.core.ITypeHierarchy;
import org.eclipse.jdt.core.JavaModelException;
/**
* A type hierarchy provides navigations between a type and its resolved
* supertypes and subtypes for a specific type or for all types within a region.
* Supertypes may extend outside of the type hierarchy's region in which it was
* created such that the root of the hierarchy is always included. For example, if a type
* hierarchy is created for a <code>java.io.File</code>, and the region the hierarchy was
* created in is the package fragment <code>java.io</code>, the supertype
* <code>java.lang.Object</code> will still be included.
* <p>
* A type hierarchy is static and can become stale. Although consistent when
* created, it does not automatically track changes in the model.
* As changes in the model potentially invalidate the hierarchy, change notifications
* are sent to registered <code>ITypeHierarchyChangedListener</code>s. Listeners should
* use the <code>exists</code> method to determine if the hierarchy has become completely
* invalid (for example, when the type or project the hierarchy was created on
* has been removed). To refresh a hierarchy, use the <code>refresh</code> method.
* </p>
* <p>
* The type hierarchy may contain cycles due to malformed supertype declarations.
* Most type hierarchy queries are oblivious to cycles; the <code>getAll* </code>
* methods are implemented such that they are unaffected by cycles.
* </p>
* <p>
* This interface is not intended to be implemented by clients.
* </p>
*/
public interface IContractHierarchy {
/**
* Adds the given listener for changes to this type hierarchy. Listeners are
* notified when this type hierarchy changes and needs to be refreshed.
* Has no effect if an identical listener is already registered.
*
* @param listener the listener
*/
void addContractHierarchyChangedListener(IContractHierarchyChangedListener listener);
/**
* Returns whether the given type is part of this hierarchy.
*
* @param type the given type
* @return true if the given type is part of this hierarchy, false otherwise
*/
boolean contains(IType type);
/**
* Returns whether the type and project this hierarchy was created on exist.
* @return true if the type and project this hierarchy was created on exist, false otherwise
*/
boolean exists();
/**
* Returns all classes in this type hierarchy's graph, in no particular
* order. Any classes in the creation region which were not resolved to
* have any subtypes or supertypes are not included in the result.
*
* @return all contracts in this contract hierarchy's graph
*/
IType[] getAllContracts();
/**
* Returns all resolved subtypes (direct and indirect) of the
* given type, in no particular order, limited to the
* types in this type hierarchy's graph. An empty array
* is returned if there are no resolved subtypes for the
* given type.
*
* @param type the given type
* @return all resolved subtypes (direct and indirect) of the given type
*/
IType[] getAllSubcontracts(IType type);
/**
* Returns all resolved superclasses of the
* given class, in bottom-up order. An empty array
* is returned if there are no resolved superclasses for the
* given class.
*
* <p>NOTE: once a type hierarchy has been created, it is more efficient to
* query the hierarchy for superclasses than to query a class recursively up
* the superclass chain. Querying an element performs a dynamic resolution,
* whereas the hierarchy returns a pre-computed result.
*
* @param type the given type
* @return all resolved superclasses of the given class, in bottom-up order, an empty
* array if none.
*/
IType[] getAllSupercontracts(IType type);
/**
* Return the flags associated with the given type (would be equivalent to <code>IMember.getFlags()</code>),
* or <code>-1</code> if this information wasn't cached on the hierarchy during its computation.
*
* @param type the given type
* @return the modifier flags for this member
* @see Flags
* @since 2.0
*/
int getCachedFlags(IType type);
/**
* Returns all classes in the graph which have no resolved superclass,
* in no particular order.
*
* @return all classes in the graph which have no resolved superclass
*/
IType[] getRootContracts();
/**
* Returns the direct resolved subclasses of the given class,
* in no particular order, limited to the classes in this
* type hierarchy's graph.
* Returns an empty collection if the given type is an interface,
* or if no classes were resolved to be subclasses of the given
* class.
*
* @param type the given type
* @return the direct resolved subclasses of the given class limited to the classes in this
* type hierarchy's graph, an empty collection if none.
*/
IType[] getSubcontracts(IType type);
/**
* Returns the resolved superclass of the given class,
* or <code>null</code> if the given class has no superclass,
* the superclass could not be resolved, or if the given
* type is an interface.
*
* @param type the given type
* @return the resolved superclass of the given class,
* or <code>null</code> if the given class has no superclass,
* the superclass could not be resolved, or if the given
* type is an interface
*/
IType[] getSupercontracts(IType type);
boolean isSupercontract(IType possibleSupercontract, IType type);
boolean isSupercontract(IType contract);
boolean isSubcontract(IType contract);
/**
* Returns the type this hierarchy was computed for.
* Returns <code>null</code> if this hierarchy was computed for a region.
*
* @return the type this hierarchy was computed for
*/
IType getType();
ITypeHierarchy getTypeHierarchy();
/**
* Re-computes the type hierarchy reporting progress.
*
* @param monitor the given progress monitor
* @exception JavaModelException if unable to refresh the hierarchy
*/
void refresh(IProgressMonitor monitor) throws JavaModelException;
/**
* Removes the given listener from this type hierarchy.
* Has no affect if an identical listener is not registered.
*
* @param listener the listener
*/
void removeContractHierarchyChangedListener(IContractHierarchyChangedListener listener);
}