1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * https://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.bcel.generic;
20
21 import org.apache.bcel.Const;
22 import org.apache.bcel.ExceptionConst;
23
24 /**
25 * PUTFIELD - Put field in object
26 *
27 * <pre>
28 * Stack: ..., objectref, value -> ...
29 * </pre>
30 *
31 * OR
32 *
33 * <pre>
34 * Stack: ..., objectref, value.word1, value.word2 -> ...
35 * </pre>
36 */
37 public class PUTFIELD extends FieldInstruction implements PopInstruction, ExceptionThrower {
38
39 /**
40 * Empty constructor needed for Instruction.readInstruction. Not to be used otherwise.
41 */
42 PUTFIELD() {
43 }
44
45 /**
46 * Constructs a PUTFIELD instruction.
47 *
48 * @param index index into constant pool.
49 */
50 public PUTFIELD(final int index) {
51 super(Const.PUTFIELD, index);
52 }
53
54 /**
55 * Call corresponding visitor method(s). The order is: Call visitor methods of implemented interfaces first, then call
56 * methods according to the class hierarchy in descending order, that is, the most specific visitXXX() call comes last.
57 *
58 * @param v Visitor object.
59 */
60 @Override
61 public void accept(final Visitor v) {
62 v.visitExceptionThrower(this);
63 v.visitStackConsumer(this);
64 v.visitPopInstruction(this);
65 v.visitTypedInstruction(this);
66 v.visitLoadClass(this);
67 v.visitCPInstruction(this);
68 v.visitFieldOrMethod(this);
69 v.visitFieldInstruction(this);
70 v.visitPUTFIELD(this);
71 }
72
73 @Override
74 public int consumeStack(final ConstantPoolGen cpg) {
75 return getFieldSize(cpg) + 1;
76 }
77
78 @Override
79 public Class<?>[] getExceptions() {
80 return ExceptionConst.createExceptions(ExceptionConst.EXCS.EXCS_FIELD_AND_METHOD_RESOLUTION, ExceptionConst.NULL_POINTER_EXCEPTION,
81 ExceptionConst.INCOMPATIBLE_CLASS_CHANGE_ERROR);
82 }
83 }