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 javax.annotation.Nonnull; 35import javax.annotation.Nullable; 36import java.util.List; 37 38/** 39 * This class represents an individual try block and associated set of handlers. 40 */ 41public interface TryBlock<EH extends ExceptionHandler> { 42 /** 43 * Gets the code offset of the start of this try block. 44 * 45 * The starting location must not occur in the middle of an instruction. 46 * 47 * @return The offset of the start of the try block from the the beginning of the bytecode for the method. The 48 * offset will be in terms of 16-bit code units. 49 */ 50 int getStartCodeAddress(); 51 52 /** 53 * Gets the number of code units covered by this try block. 54 * 55 * The end of the try block is typically coincident with the end of an instruction, but does not strictly need to 56 * be. If the last instruction is only partly covered by this try block, it is considered to be covered. 57 * 58 * @return The number of code units covered by this try block. 59 */ 60 int getCodeUnitCount(); 61 62 /** 63 * A list of the exception handlers associated with this try block. 64 * 65 * The exception handlers in the returned list will all have a unique type, including at most 1 with no type, which 66 * is the catch-all handler. If present, the catch-all handler is always the last item in the list. 67 * 68 * @return A list of ExceptionHandler objects 69 */ 70 @Nonnull List<? extends EH> getExceptionHandlers(); 71 72 /** 73 * Compares this TryBlock to another TryBlock for equality. 74 * 75 * This TryBlock is equal to another TryBlock if all 3 fields are equal. The exception handlers are tested for 76 * equality using the usual List equality semantics. 77 * 78 * @param o The object to be compared for equality with this TryBlock 79 * @return true if the specified object is equal to this TryBlock 80 */ 81 @Override boolean equals(@Nullable Object o); 82} 83