1 /*
   2  * Copyright 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 
  26 package com.sun.mirror.util;
  27 
  28 
  29 import com.sun.mirror.declaration.*;
  30 
  31 
  32 /**
  33  * Utility methods for operating on declarations.
  34  *
  35  * @author Joseph D. Darcy
  36  * @author Scott Seligman
  37  * @since 1.5
  38  */
  39 
  40 public interface Declarations {
  41 
  42     /**
  43      * Tests whether one type, method, or field declaration hides another.
  44      *
  45      * @param sub the first member
  46      * @param sup the second member
  47      * @return <tt>true</tt> if and only if the first member hides
  48      *          the second
  49      */
  50     boolean hides(MemberDeclaration sub, MemberDeclaration sup);
  51 
  52     /**
  53      * Tests whether one method overrides another.  When a
  54      * non-abstract method overrides an abstract one, the
  55      * former is also said to <i>implement</i> the latter.
  56      *
  57      * @param sub the first method
  58      * @param sup the second method
  59      * @return <tt>true</tt> if and only if the first method overrides
  60      *          the second
  61      */
  62     boolean overrides(MethodDeclaration sub, MethodDeclaration sup);
  63 }