TryBlock.java revision 22c3185bb7c8618437eabe6c597549e0989ec4e6 
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 java.util.Set;
36
37/**
38 * This class represents an individual try block and associated set of handlers.
39 */
40public interface TryBlock {
41    /**
42     * Gets the code offset of the start of this try block.
43     *
44     * The starting location must not occur in the middle of an instruction.
45     *
46     * @return The offset of the start of the try block from the the beginning of the bytecode for the method. The
47     * offset will be in terms of 16-bit code units.
48     */
49    int getStartCodeAddress();
50
51    /**
52     * Gets the number of code units covered by this try block.
53     *
54     * The end of the try block is typically coincident with the end of an instruction, but does not strictly need to
55     * be. If the last instruction is only partly covered by this try block, it is considered to be covered.
56     *
57     * @return The number of code units covered by this try block.
58     */
59    int getCodeUnitCount();
60
61    /**
62     * A set of the exception handlers associated with this try block.
63     *
64     * The exception handlers in the returned set will all have a unique type, including at most 1 with no type, which
65     * is the catch-all handler.
66     *
67     * @return A set of ExceptionHandler objects
68     */
69    @Nonnull Set<? extends ExceptionHandler> getExceptionHandlers();
70}
71