View Javadoc
1   /*
2    * reserved comment block
3    * DO NOT REMOVE OR ALTER!
4    */
5   package com.sun.org.apache.bcel.internal.generic;
6   
7   /* ====================================================================
8    * The Apache Software License, Version 1.1
9    *
10   * Copyright (c) 2001 The Apache Software Foundation.  All rights
11   * reserved.
12   *
13   * Redistribution and use in source and binary forms, with or without
14   * modification, are permitted provided that the following conditions
15   * are met:
16   *
17   * 1. Redistributions of source code must retain the above copyright
18   *    notice, this list of conditions and the following disclaimer.
19   *
20   * 2. Redistributions in binary form must reproduce the above copyright
21   *    notice, this list of conditions and the following disclaimer in
22   *    the documentation and/or other materials provided with the
23   *    distribution.
24   *
25   * 3. The end-user documentation included with the redistribution,
26   *    if any, must include the following acknowledgment:
27   *       "This product includes software developed by the
28   *        Apache Software Foundation (http://www.apache.org/)."
29   *    Alternately, this acknowledgment may appear in the software itself,
30   *    if and wherever such third-party acknowledgments normally appear.
31   *
32   * 4. The names "Apache" and "Apache Software Foundation" and
33   *    "Apache BCEL" must not be used to endorse or promote products
34   *    derived from this software without prior written permission. For
35   *    written permission, please contact apache@apache.org.
36   *
37   * 5. Products derived from this software may not be called "Apache",
38   *    "Apache BCEL", nor may "Apache" appear in their name, without
39   *    prior written permission of the Apache Software Foundation.
40   *
41   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52   * SUCH DAMAGE.
53   * ====================================================================
54   *
55   * This software consists of voluntary contributions made by many
56   * individuals on behalf of the Apache Software Foundation.  For more
57   * information on the Apache Software Foundation, please see
58   * <http://www.apache.org/>.
59   */
60  
61  /**
62   * Thrown by InstructionList.remove() when one or multiple disposed instruction
63   * are still being referenced by a InstructionTargeter object. I.e. the
64   * InstructionTargeter has to be notified that (one of) the InstructionHandle it
65   * is referencing is being removed from the InstructionList and thus not valid anymore.
66   *
67   * Making this an exception instead of a return value forces the user to handle
68   * these case explicitely in a try { ... } catch. The following code illustrates
69   * how this may be done:
70   *
71   * <PRE>
72   *     ...
73   *     try {
74   *      il.delete(start_ih, end_ih);
75   *     } catch(TargetLostException e) {
76   *       InstructionHandle[] targets = e.getTargets();
77   *       for(int i=0; i < targets.length; i++) {
78   *         InstructionTargeter[] targeters = targets[i].getTargeters();
79   *
80   *         for(int j=0; j < targeters.length; j++)
81   *           targeters[j].updateTarget(targets[i], new_target);
82   *       }
83   *     }
84   * </PRE>
85   *
86   * @see InstructionHandle
87   * @see InstructionList
88   * @see InstructionTargeter
89   * @author  <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A>
90   */
91  public final class TargetLostException extends Exception {
92    private InstructionHandle[] targets;
93  
94    TargetLostException(InstructionHandle[] t, String mesg) {
95      super(mesg);
96      targets = t;
97    }
98  
99    /**
100    * @return list of instructions still being targeted.
101    */
102   public InstructionHandle[] getTargets() { return targets; }
103 }