1f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 2f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 3f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 4f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * you may not use this file except in compliance with the License. 6f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * You may obtain a copy of the License at 7f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 8f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 10f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * See the License for the specific language governing permissions and 14f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * limitations under the License. 15f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 16f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 17f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectpackage com.android.dx.cf.iface; 18f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 19b7d748318354aba23ba03f76bdefc31fa6adc885Orion Hodsonimport com.android.dx.cf.code.BootstrapMethodsList; 20f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.rop.cst.ConstantPool; 21333201833d506a3accdeac6ceb7caba8d4b95797Jesse Wilsonimport com.android.dx.rop.cst.CstString; 22f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.rop.cst.CstType; 23f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.rop.type.TypeList; 24f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 25f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/** 26f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Interface for things which purport to be class files or reasonable 27f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * facsimiles thereof. 28f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 29f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <p><b>Note:</b> The fields referred to in this documentation are of the 3099409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * {@code ClassFile} structure defined in vmspec-2 sec4.1. 31f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 32893795fc95fdd77d398ebb77a0fe336c45b596cfYohann Rousselpublic interface ClassFile extends HasAttribute { 33f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 3499409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Gets the field {@code magic}. 35f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 36f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return the value in question 37f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 38f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int getMagic(); 39f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 40f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 4199409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Gets the field {@code minor_version}. 42f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 43f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return the value in question 44f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 45f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int getMinorVersion(); 46f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 47f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 4899409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Gets the field {@code major_version}. 49f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 50f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return the value in question 51f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 52f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int getMajorVersion(); 53f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 54f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 5599409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Gets the field {@code access_flags}. 56f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 57f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return the value in question 58f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 59f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int getAccessFlags(); 60f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 61f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 6299409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Gets the field {@code this_class}, interpreted as a type constant. 63f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 6499409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code non-null;} the value in question 65f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 66f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public CstType getThisClass(); 67f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 68f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 6999409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Gets the field {@code super_class}, interpreted as a type constant 70f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if non-zero. 71f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 7299409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code null-ok;} the value in question 73f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 74f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public CstType getSuperclass(); 75f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 76f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 7799409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Gets the field {@code constant_pool} (along with 7899409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * {@code constant_pool_count}). 79f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 8099409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code non-null;} the constant pool 81f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 82f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public ConstantPool getConstantPool(); 83f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 84f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 85de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * Gets the field {@code interfaces} (along with 8699409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * {@code interfaces_count}). 87f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 8899409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code non-null;} the list of interfaces 89f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 90f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public TypeList getInterfaces(); 91f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 92f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 9399409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Gets the field {@code fields} (along with 9499409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * {@code fields_count}). 95f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 9699409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code non-null;} the list of fields 97f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 98f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public FieldList getFields(); 99f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 100f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 10199409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Gets the field {@code methods} (along with 10299409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * {@code methods_count}). 103f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 10499409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code non-null;} the list of fields 105f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 106f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public MethodList getMethods(); 107f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 108f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 10999409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Gets the field {@code attributes} (along with 11099409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * {@code attributes_count}). 111f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 11299409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code non-null;} the list of attributes 113f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 1149dbd802c8c96c3a66873bc600bc7d1374a1d08e5Orion Hodson @Override 115f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public AttributeList getAttributes(); 116f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 117f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 118b7d748318354aba23ba03f76bdefc31fa6adc885Orion Hodson * Gets the bootstrap method {@code attributes}. 119b7d748318354aba23ba03f76bdefc31fa6adc885Orion Hodson * @return {@code non-null;} the list of bootstrap methods 120b7d748318354aba23ba03f76bdefc31fa6adc885Orion Hodson */ 121b7d748318354aba23ba03f76bdefc31fa6adc885Orion Hodson public BootstrapMethodsList getBootstrapMethods(); 122b7d748318354aba23ba03f76bdefc31fa6adc885Orion Hodson 123b7d748318354aba23ba03f76bdefc31fa6adc885Orion Hodson /** 12499409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Gets the name out of the {@code SourceFile} attribute of this 125f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * file, if any. This is a convenient shorthand for scrounging around 126f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * the class's attributes. 127f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 12899409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code non-null;} the constant pool 129f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 130333201833d506a3accdeac6ceb7caba8d4b95797Jesse Wilson public CstString getSourceFile(); 131f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 132