blob: c924dea0470f5f3b358a444a8326546c707e1ea8 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 1998-2004 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26package com.sun.jdi;
27
28import java.util.List;
29
30/**
31 * A mirror of an interface in the target VM. An InterfaceType is
32 * a refinement of {@link ReferenceType} that applies to true interfaces
33 * in the JLS sense of the definition (not a class, not an array type).
34 * An interface type will never be returned by
35 * {@link ObjectReference#referenceType}, but it may be in the list
36 * of implemented interfaces for a {@link ClassType} that is returned
37 * by that method.
38 *
39 * @see ObjectReference
40 *
41 * @author Robert Field
42 * @author Gordon Hirsch
43 * @author James McIlree
44 * @since 1.3
45 */
46public interface InterfaceType extends ReferenceType {
47 /**
48 * Gets the interfaces directly extended by this interface.
49 * The returned list contains only those interfaces this
50 * interface has declared to be extended.
51 *
52 * @return a List of {@link InterfaceType} objects each mirroring
53 * an interface extended by this interface.
54 * If none exist, returns a zero length List.
55 * @throws ClassNotPreparedException if this class not yet been
56 * prepared.
57 */
58 List<InterfaceType> superinterfaces();
59
60 /**
61 * Gets the currently prepared interfaces which directly extend this
62 * interface. The returned list contains only those interfaces that
63 * declared this interface in their "extends" clause.
64 *
65 * @return a List of {@link InterfaceType} objects each mirroring
66 * an interface extending this interface.
67 * If none exist, returns a zero length List.
68 */
69 List<InterfaceType> subinterfaces();
70
71 /**
72 * Gets the currently prepared classes which directly implement this
73 * interface. The returned list contains only those classes that
74 * declared this interface in their "implements" clause.
75 *
76 * @return a List of {@link ClassType} objects each mirroring
77 * a class implementing this interface.
78 * If none exist, returns a zero length List.
79 */
80 List<ClassType> implementors();
81}