dexlib2/src/main/java/org/jf/dexlib2/iface/ClassDef.java

/*
 * Copyright 2012, Google Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.jf.dexlib2.iface;

import org.jf.dexlib2.iface.reference.TypeReference;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.List;
import java.util.Set;

/**
 * This class represents a class definition.
 *
 * It also acts as a TypeReference to itself. Any equality/comparison is based on its identity as a TypeReference,
 * and shouldn't take into account anything other than the type of this class.
 */
public interface ClassDef extends TypeReference, Annotatable {
    /**
     * Gets the class type.
     *
     * This will be a type descriptor per the dex file specification.
     *
     * @return The class type
     */
    @Override @Nonnull String getType();

    /**
     * Gets the access flags for this class.
     *
     * This will be a combination of the AccessFlags.* flags that are marked as compatible for use with a class.
     *
     * @return The access flags for this class
     */
    int getAccessFlags();

    /**
     * Gets the superclass of this class.
     *
     * This will only be null if this is the base java.lang.Object class.
     *
     * @return The superclass of this class
     */
    @Nullable String getSuperclass();

    /**
     * Gets a list of the interfaces that this class implements.
     *
     * @return A list of the interfaces that this class implements
     */
    @Nonnull List<String> getInterfaces();

    /**
     * Gets the name of the primary source file that this class is defined in, if available.
     *
     * This will be the default source file associated with all methods defined in this class. This can be overridden
     * for sections of an individual method with the SetSourceFile debug item.
     *
     * @return The name of the primary source file for this class, or null if not available
     */
    @Nullable String getSourceFile();

    /**
     * Gets a set of the annotations that are applied to this class.
     *
     * The annotations in the returned set are guaranteed to have unique types.
     *
     * @return A set of the annotations that are applied to this class
     */
    @Override @Nonnull Set<? extends Annotation> getAnnotations();

    /**
     * Gets the static fields that are defined by this class.
     *
     * The static fields that are returned must have no duplicates.
     *
     * @return The static fields that are defined by this class
     */
    @Nonnull Iterable<? extends Field> getStaticFields();

    /**
     * Gets the instance fields that are defined by this class.
     *
     * The instance fields that are returned must have no duplicates.
     *
     * @return The instance fields that are defined by this class
     */
    @Nonnull Iterable<? extends Field> getInstanceFields();

    /**
     * Gets all the fields that are defined by this class.
     *
     * This is a convenience method that combines getStaticFields() and getInstanceFields()
     *
     * The returned fields may be in any order. I.e. It's not safe to assume that all instance fields will come after
     * all static fields.
     *
     * Note that there typically should not be any duplicate fields between the two, but some versions of
     * dalvik inadvertently allow duplicate static/instance fields, and are supported here for completeness
     *
     * @return A set of the fields that are defined by this class
     */
    @Nonnull Iterable<? extends Field> getFields();

    /**
     * Gets the direct methods that are defined by this class.
     *
     * The direct methods that are returned must have no duplicates.
     *
     * @return The direct methods that are defined by this class.
     */
    @Nonnull Iterable<? extends Method> getDirectMethods();

    /**
     * Gets the virtual methods that are defined by this class.
     *
     * The virtual methods that are returned must have no duplicates.
     *
     * @return The virtual methods that are defined by this class.
     */
    @Nonnull Iterable<? extends Method> getVirtualMethods();

    /**
     * Gets all the methods that are defined by this class.
     *
     * This is a convenience method that combines getDirectMethods() and getVirtualMethods().
     *
     * The returned methods may be in any order. I.e. It's not safe to assume that all virtual methods will come after
     * all direct methods.
     *
     * Note that there typically should not be any duplicate methods between the two, but some versions of
     * dalvik inadvertently allow duplicate direct/virtual methods, and are supported here for completeness
     *
     * @return An iterable of the methods that are defined by this class.
     */
    @Nonnull Iterable<? extends Method> getMethods();
}