Add Member and Annotatable interfaces

This commit is contained in:
Ben Gruver 2015-03-16 20:52:55 -07:00 committed by Connor Tumbleson
parent eb3b01f318
commit 6d3497f72d
5 changed files with 123 additions and 11 deletions

View File

@ -0,0 +1,49 @@
/*
* Copyright 2015, 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 javax.annotation.Nonnull;
import java.util.Set;
/**
* This class represents an object that can have Annotations applied to it
*/
public interface Annotatable {
/**
* Gets a set of the annotations that are applied to this object.
*
* The annotations in the returned set are guaranteed to have unique types.
*
* @return A set of the annotations that are applied to this object
*/
@Nonnull Set<? extends Annotation> getAnnotations();
}

View File

@ -43,7 +43,7 @@ import java.util.Set;
* It also acts as a TypeReference to itself. Any equality/comparison is based on its identity as a TypeReference, * 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. * and shouldn't take into account anything other than the type of this class.
*/ */
public interface ClassDef extends TypeReference { public interface ClassDef extends TypeReference, Annotatable {
/** /**
* Gets the class type. * Gets the class type.
* *
@ -95,7 +95,7 @@ public interface ClassDef extends TypeReference {
* *
* @return A set of the annotations that are applied to this class * @return A set of the annotations that are applied to this class
*/ */
@Nonnull Set<? extends Annotation> getAnnotations(); @Override @Nonnull Set<? extends Annotation> getAnnotations();
/** /**
* Gets the static fields that are defined by this class. * Gets the static fields that are defined by this class.

View File

@ -44,27 +44,27 @@ import java.util.Set;
* It also acts as a FieldReference to itself. Any equality/comparison is based on its identity as a FieldReference, * It also acts as a FieldReference to itself. Any equality/comparison is based on its identity as a FieldReference,
* and shouldn't take into account any non-FieldReference specifics of this field. * and shouldn't take into account any non-FieldReference specifics of this field.
*/ */
public interface Field extends FieldReference { public interface Field extends FieldReference, Member {
/** /**
* Gets the type of the class that defines this field. * Gets the type of the class that defines this field.
* *
* @return The type of the class that defines this field * @return The type of the class that defines this field
*/ */
@Nonnull String getDefiningClass(); @Override @Nonnull String getDefiningClass();
/** /**
* Gets the name of this field. * Gets the name of this field.
* *
* @return The name of this field * @return The name of this field
*/ */
@Nonnull String getName(); @Override @Nonnull String getName();
/** /**
* Gets the type of this field. * Gets the type of this field.
* *
* @return The type of this field * @return The type of this field
*/ */
@Nonnull String getType(); @Override @Nonnull String getType();
/** /**
* Gets the access flags for this field. * Gets the access flags for this field.
@ -73,7 +73,7 @@ public interface Field extends FieldReference {
* *
* @return The access flags for this field * @return The access flags for this field
*/ */
int getAccessFlags(); @Override int getAccessFlags();
/** /**
* Gets the initial value for this field, if available. * Gets the initial value for this field, if available.
@ -92,5 +92,5 @@ public interface Field extends FieldReference {
* *
* @return A set of the annotations that are applied to this field * @return A set of the annotations that are applied to this field
*/ */
@Nonnull Set<? extends Annotation> getAnnotations(); @Override @Nonnull Set<? extends Annotation> getAnnotations();
} }

View File

@ -0,0 +1,63 @@
/*
* Copyright 2015, 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 javax.annotation.Nonnull;
/**
* This class represents a generic class member
*/
public interface Member extends Annotatable {
/**
* Gets the type of the class that defines this member.
*
* @return The type of the class that defines this member
*/
@Nonnull String getDefiningClass();
/**
* Gets the name of this member.
*
* @return The name of this field
*/
@Nonnull String getName();
/**
* Gets the access flags for this member.
*
* This will be a combination of the AccessFlags.* flags that are marked as compatible for use with this type
* of member.
*
* @return The access flags for this member
*/
int getAccessFlags();
}

View File

@ -44,7 +44,7 @@ import java.util.Set;
* It also acts as a MethodReference to itself. Any equality/comparison is based on its identity as a MethodReference, * It also acts as a MethodReference to itself. Any equality/comparison is based on its identity as a MethodReference,
* and shouldn't take into account any non-MethodReference specifics of this method. * and shouldn't take into account any non-MethodReference specifics of this method.
*/ */
public interface Method extends MethodReference { public interface Method extends MethodReference, Member {
/** /**
* Gets the type of the class that defines this method. * Gets the type of the class that defines this method.
* *
@ -86,7 +86,7 @@ public interface Method extends MethodReference {
* *
* @return The access flags for this method * @return The access flags for this method
*/ */
int getAccessFlags(); @Override int getAccessFlags();
/** /**
* Gets a set of the annotations that are applied to this method. * Gets a set of the annotations that are applied to this method.
@ -95,7 +95,7 @@ public interface Method extends MethodReference {
* *
* @return A set of the annotations that are applied to this method * @return A set of the annotations that are applied to this method
*/ */
@Nonnull Set<? extends Annotation> getAnnotations(); @Override @Nonnull Set<? extends Annotation> getAnnotations();
/** /**
* Gets a MethodImplementation object that defines the implementation of the method. * Gets a MethodImplementation object that defines the implementation of the method.