001    /*
002     * Copyright 2004 Sun Microsystems, Inc.  All Rights Reserved.
003     * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004     *
005     * This code is free software; you can redistribute it and/or modify it
006     * under the terms of the GNU General Public License version 2 only, as
007     * published by the Free Software Foundation.  Sun designates this
008     * particular file as subject to the "Classpath" exception as provided
009     * by Sun in the LICENSE file that accompanied this code.
010     *
011     * This code is distributed in the hope that it will be useful, but WITHOUT
012     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013     * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014     * version 2 for more details (a copy is included in the LICENSE file that
015     * accompanied this code).
016     *
017     * You should have received a copy of the GNU General Public License version
018     * 2 along with this work; if not, write to the Free Software Foundation,
019     * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020     *
021     * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022     * CA 95054 USA or visit www.sun.com if you need additional information or
023     * have any questions.
024     */
025    
026    package com.sun.mirror.util;
027    
028    
029    import com.sun.mirror.declaration.*;
030    
031    
032    /**
033     * Utility methods for operating on declarations.
034     *
035     * @author Joseph D. Darcy
036     * @author Scott Seligman
037     * @since 1.5
038     */
039    
040    public interface Declarations {
041    
042        /**
043         * Tests whether one type, method, or field declaration hides another.
044         *
045         * @param sub the first member
046         * @param sup the second member
047         * @return <tt>true</tt> if and only if the first member hides
048         *          the second
049         */
050        boolean hides(MemberDeclaration sub, MemberDeclaration sup);
051    
052        /**
053         * Tests whether one method overrides another.  When a
054         * non-abstract method overrides an abstract one, the
055         * former is also said to <i>implement</i> the latter.
056         *
057         * @param sub the first method
058         * @param sup the second method
059         * @return <tt>true</tt> if and only if the first method overrides
060         *          the second
061         */
062        boolean overrides(MethodDeclaration sub, MethodDeclaration sup);
063    }