1 /*
   2  * Copyright (c) 1998, 2004, Oracle and/or its affiliates. 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.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.jdi;
  27 
  28 import 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  */
  46 @jdk.Supported
  47 public interface InterfaceType extends ReferenceType {
  48     /**
  49      * Gets the interfaces directly extended by this interface.
  50      * The returned list contains only those interfaces this
  51      * interface has declared to be extended.
  52      *
  53      * @return a List of {@link InterfaceType} objects each mirroring
  54      * an interface extended by this interface.
  55      * If none exist, returns a zero length List.
  56      * @throws ClassNotPreparedException if this class not yet been
  57      * prepared.
  58      */
  59     List<InterfaceType> superinterfaces();
  60 
  61     /**
  62      * Gets the currently prepared interfaces which directly extend this
  63      * interface. The returned list contains only those interfaces that
  64      * declared this interface in their "extends" clause.
  65      *
  66      * @return a List of {@link InterfaceType} objects each mirroring
  67      * an interface extending this interface.
  68      * If none exist, returns a zero length List.
  69      */
  70     List<InterfaceType> subinterfaces();
  71 
  72     /**
  73      * Gets the currently prepared classes which directly implement this
  74      * interface. The returned list contains only those classes that
  75      * declared this interface in their "implements" clause.
  76      *
  77      * @return a List of {@link ClassType} objects each mirroring
  78      * a class implementing this interface.
  79      * If none exist, returns a zero length List.
  80      */
  81     List<ClassType> implementors();
  82 }