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 32package org.jf.dexlib2.iface; 33 34import org.jf.dexlib2.iface.reference.FieldReference; 35import org.jf.dexlib2.iface.value.EncodedValue; 36 37import javax.annotation.Nonnull; 38import javax.annotation.Nullable; 39import java.util.Set; 40 41/** 42 * This class represents a specific field definition in a class. 43 * 44 * It also acts as a FieldReference to itself. Any equality/comparison is based on its identity as a FieldReference, 45 * and shouldn't take into account any non-FieldReference specifics of this field. 46 */ 47public interface Field extends FieldReference { 48 /** 49 * Gets the type of the class that defines this field. 50 * 51 * @return The type of the class that defines this field 52 */ 53 @Nonnull String getDefiningClass(); 54 55 /** 56 * Gets the name of this field. 57 * 58 * @return The name of this field 59 */ 60 @Nonnull String getName(); 61 62 /** 63 * Gets the type of this field. 64 * 65 * @return The type of this field 66 */ 67 @Nonnull String getType(); 68 69 /** 70 * Gets the access flags for this field. 71 * 72 * This will be a combination of the AccessFlags.* flags that are marked as compatible for use with a field. 73 * 74 * @return The access flags for this field 75 */ 76 int getAccessFlags(); 77 78 /** 79 * Gets the initial value for this field, if available. 80 * 81 * Only static field may have an initial value set, but are not required to have an initial value. 82 * 83 * @return The initial value for this field, or null if this field is not a static field, or if this static field 84 * does not have an initial value. 85 */ 86 @Nullable EncodedValue getInitialValue(); 87 88 /** 89 * Gets a set of the annotations that are applied to this field. 90 * 91 * The annotations in the returned set are guaranteed to have unique types. 92 * 93 * @return A set of the annotations that are applied to this field 94 */ 95 @Nonnull Set<? extends Annotation> getAnnotations(); 96} 97