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 import com.sun.org.apache.bcel.internal.Constants;
61 import java.util.Objects;
62 
63 /**
64  * Returnaddress, the type JSR or JSR_W instructions push upon the stack.
65  *
66  * see vmspec2 3.3.3
67  * @author  <A HREF="http://www.inf.fu-berlin.de/~ehaase">Enver Haase</A>
68  */
69 public class ReturnaddressType extends Type {
70 
71   public static final ReturnaddressType NO_TARGET = new ReturnaddressType();
72   private InstructionHandle returnTarget;
73 
74   /**
75    * A Returnaddress [that doesn't know where to return to].
76    */
ReturnaddressType()77   private ReturnaddressType(){
78     super(Constants.T_ADDRESS, "<return address>");
79   }
80 
81   /**
82    * Creates a ReturnaddressType object with a target.
83    */
ReturnaddressType(InstructionHandle returnTarget)84   public ReturnaddressType(InstructionHandle returnTarget) {
85     super(Constants.T_ADDRESS, "<return address targeting "+returnTarget+">");
86         this.returnTarget = returnTarget;
87   }
88 
89   @Override
hashCode()90   public int hashCode() {
91       return Objects.hashCode(this.returnTarget);
92   }
93 
94   /**
95    * Returns if the two Returnaddresses refer to the same target.
96    */
97   @Override
equals(Object rat)98   public boolean equals(Object rat){
99     if(!(rat instanceof ReturnaddressType))
100       return false;
101 
102     return ((ReturnaddressType)rat).returnTarget.equals(this.returnTarget);
103   }
104 
105   /**
106    * @return the target of this ReturnaddressType
107    */
getTarget()108   public InstructionHandle getTarget(){
109     return returnTarget;
110   }
111 }
112