Home | History | Annotate | Download | only in iface 
      1 /*
      2  * Copyright 2012, Google Inc.
      3  * All rights reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions are
      7  * met:
      8  *
      9  *     * Redistributions of source code must retain the above copyright
     10  * notice, this list of conditions and the following disclaimer.
     11  *     * Redistributions in binary form must reproduce the above
     12  * copyright notice, this list of conditions and the following disclaimer
     13  * in the documentation and/or other materials provided with the
     14  * distribution.
     15  *     * Neither the name of Google Inc. nor the names of its
     16  * contributors may be used to endorse or promote products derived from
     17  * this software without specific prior written permission.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 package org.jf.dexlib2.iface;
     33 
     34 import org.jf.dexlib2.iface.reference.MethodReference;
     35 
     36 import javax.annotation.Nonnull;
     37 import javax.annotation.Nullable;
     38 import java.util.List;
     39 import java.util.Set;
     40 
     41 /**
     42  * This class represents a specific method definition in a class.
     43  *
     44  * It also acts as a MethodReference to itself. Any equality/comparison is based on its identity as a MethodReference,
     45  * and shouldn't take into account any non-MethodReference specifics of this method.
     46  */
     47 public interface Method extends MethodReference, Member {
     48     /**
     49      * Gets the type of the class that defines this method.
     50      *
     51      * @return The type of the class that defines this method
     52      */
     53     @Override @Nonnull String getDefiningClass();
     54 
     55     /**
     56      * Gets the name of this method.
     57      *
     58      * @return The name of this method
     59      */
     60     @Override @Nonnull String getName();
     61 
     62     /**
     63      * Gets a list of the parameters of this method.
     64      *
     65      * As per the MethodReference interface, the MethodParameter objects contained in the returned list also act
     66      * as a simple reference to the type of the parameter. However, the MethodParameter object can also contain
     67      * additional information about the parameter.
     68      *
     69      * Note: In some implementations, the returned list is likely to *not* provide efficient random access.
     70      *
     71      * @return A list of MethodParameter objects, representing the parameters of this method.
     72      */
     73     @Nonnull List<? extends MethodParameter> getParameters();
     74 
     75     /**
     76      * Gets the return type of this method.
     77      *
     78      * @return The return type of this method.
     79      */
     80     @Override @Nonnull String getReturnType();
     81 
     82     /**
     83      * Gets the access flags for this method.
     84      *
     85      * This will be a combination of the AccessFlags.* flags that are marked as compatible for use with a method.
     86      *
     87      * @return The access flags for this method
     88      */
     89     @Override int getAccessFlags();
     90 
     91     /**
     92      * Gets a set of the annotations that are applied to this method.
     93      *
     94      * The annotations in the returned set are guaranteed to have unique types.
     95      *
     96      * @return A set of the annotations that are applied to this method
     97      */
     98     @Override @Nonnull Set<? extends Annotation> getAnnotations();
     99 
    100     /**
    101      * Gets a MethodImplementation object that defines the implementation of the method.
    102      *
    103      * If this is an abstract method in an abstract class, or an interface method in an interface definition, then the
    104      * method has no implementation, and this will return null.
    105      *
    106      * @return A MethodImplementation object defining the implementation of this method, or null if the method has no
    107      * implementation
    108      */
    109     @Nullable MethodImplementation getImplementation();
    110 }
    111