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.classfile;
019
020import java.io.DataInput;
021import java.io.DataOutputStream;
022import java.io.IOException;
023
024import org.apache.bcel.Const;
025
026/**
027 * This class is derived from the abstract {@link Constant} and represents a reference to a float object.
028 *
029 * @see Constant
030 */
031public final class ConstantFloat extends Constant implements ConstantObject {
032
033    private float bytes;
034
035    /**
036     * Initialize from another object. Note that both objects use the same references (shallow copy). Use clone() for a
037     * physical copy.
038     */
039    public ConstantFloat(final ConstantFloat c) {
040        this(c.getBytes());
041    }
042
043    /**
044     * Initialize instance from file data.
045     *
046     * @param file Input stream
047     * @throws IOException if an I/O error occurs.
048     */
049    ConstantFloat(final DataInput file) throws IOException {
050        this(file.readFloat());
051    }
052
053    /**
054     * @param bytes Data
055     */
056    public ConstantFloat(final float bytes) {
057        super(Const.CONSTANT_Float);
058        this.bytes = bytes;
059    }
060
061    /**
062     * Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class.
063     * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree of objects.
064     *
065     * @param v Visitor object
066     */
067    @Override
068    public void accept(final Visitor v) {
069        v.visitConstantFloat(this);
070    }
071
072    /**
073     * Dump constant float to file stream in binary format.
074     *
075     * @param file Output file stream
076     * @throws IOException if an I/O error occurs.
077     */
078    @Override
079    public void dump(final DataOutputStream file) throws IOException {
080        file.writeByte(super.getTag());
081        file.writeFloat(bytes);
082    }
083
084    /**
085     * @return data, i.e., 4 bytes.
086     */
087    public float getBytes() {
088        return bytes;
089    }
090
091    /**
092     * @return Float object
093     */
094    @Override
095    public Object getConstantValue(final ConstantPool cp) {
096        return Float.valueOf(bytes);
097    }
098
099    /**
100     * @param bytes the raw bytes that represent this float
101     */
102    public void setBytes(final float bytes) {
103        this.bytes = bytes;
104    }
105
106    /**
107     * @return String representation.
108     */
109    @Override
110    public String toString() {
111        return super.toString() + "(bytes = " + bytes + ")";
112    }
113}