001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   https://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.bcel.generic;
020
021import org.apache.bcel.Const;
022import org.apache.bcel.ExceptionConst;
023
024/**
025 * PUTFIELD - Put field in object
026 *
027 * <pre>
028 * Stack: ..., objectref, value -&gt; ...
029 * </pre>
030 *
031 * OR
032 *
033 * <pre>
034 * Stack: ..., objectref, value.word1, value.word2 -&gt; ...
035 * </pre>
036 */
037public class PUTFIELD extends FieldInstruction implements PopInstruction, ExceptionThrower {
038
039    /**
040     * Empty constructor needed for Instruction.readInstruction. Not to be used otherwise.
041     */
042    PUTFIELD() {
043    }
044
045    /**
046     * Constructs a PUTFIELD instruction.
047     *
048     * @param index index into constant pool.
049     */
050    public PUTFIELD(final int index) {
051        super(Const.PUTFIELD, index);
052    }
053
054    /**
055     * Call corresponding visitor method(s). The order is: Call visitor methods of implemented interfaces first, then call
056     * methods according to the class hierarchy in descending order, that is, the most specific visitXXX() call comes last.
057     *
058     * @param v Visitor object.
059     */
060    @Override
061    public void accept(final Visitor v) {
062        v.visitExceptionThrower(this);
063        v.visitStackConsumer(this);
064        v.visitPopInstruction(this);
065        v.visitTypedInstruction(this);
066        v.visitLoadClass(this);
067        v.visitCPInstruction(this);
068        v.visitFieldOrMethod(this);
069        v.visitFieldInstruction(this);
070        v.visitPUTFIELD(this);
071    }
072
073    @Override
074    public int consumeStack(final ConstantPoolGen cpg) {
075        return getFieldSize(cpg) + 1;
076    }
077
078    @Override
079    public Class<?>[] getExceptions() {
080        return ExceptionConst.createExceptions(ExceptionConst.EXCS.EXCS_FIELD_AND_METHOD_RESOLUTION, ExceptionConst.NULL_POINTER_EXCEPTION,
081            ExceptionConst.INCOMPATIBLE_CLASS_CHANGE_ERROR);
082    }
083}