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