/*
 * Copyright  2000-2004 The Apache Software Foundation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License"); 
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License. 
 *
 */
package org.apache.bcel.classfile;

import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import org.apache.bcel.Constants;

/**
 * This class is derived from <em>Attribute</em> and denotes that this is a
 * deprecated method. It is instantiated from the
 * <em>Attribute.readAttribute()</em> method.
 * 
 * @version $Id: Deprecated.java 386056 2006-03-15 11:31:56Z tcurdt $
 * @author <A HREF="mailto:m.dahm@gmx.de">M. Dahm</A>
 * @see Attribute
 */
public final class Deprecated extends Attribute {

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	private byte[] bytes;

	/**
	 * Initialize from another object. Note that both objects use the same
	 * references (shallow copy). Use clone() for a physical copy.
	 */
	public Deprecated(Deprecated c) {
		this(c.getNameIndex(), c.getLength(), c.getBytes(), c.getConstantPool());
	}

	/**
	 * @param name_index
	 *            Index in constant pool to CONSTANT_Utf8
	 * @param length
	 *            Content length in bytes
	 * @param bytes
	 *            Attribute contents
	 * @param constant_pool
	 *            Array of constants
	 */
	public Deprecated(int name_index, int length, byte[] bytes,
			ConstantPool constant_pool) {
		super(Constants.ATTR_DEPRECATED, name_index, length, constant_pool);
		this.bytes = bytes;
	}

	/**
	 * Construct object from file stream.
	 * 
	 * @param name_index
	 *            Index in constant pool to CONSTANT_Utf8
	 * @param length
	 *            Content length in bytes
	 * @param file
	 *            Input stream
	 * @param constant_pool
	 *            Array of constants
	 * @throws IOException
	 */
	Deprecated(int name_index, int length, DataInputStream file,
			ConstantPool constant_pool) throws IOException {
		this(name_index, length, (byte[]) null, constant_pool);
		if (length > 0) {
			bytes = new byte[length];
			file.readFully(bytes);
			System.err.println("Deprecated attribute with length > 0");
		}
	}

	/**
	 * Called by objects that are traversing the nodes of the tree implicitely
	 * defined by the contents of a Java class. I.e., the hierarchy of methods,
	 * fields, attributes, etc. spawns a tree of objects.
	 * 
	 * @param v
	 *            Visitor object
	 */
	@Override
	public void accept(Visitor v) {
		v.visitDeprecated(this);
	}

	/**
	 * Dump source file attribute to file stream in binary format.
	 * 
	 * @param file
	 *            Output file stream
	 * @throws IOException
	 */
	@Override
	public final void dump(DataOutputStream file) throws IOException {
		super.dump(file);
		if (length > 0) {
			file.write(bytes, 0, length);
		}
	}

	/**
	 * @return data bytes.
	 */
	public final byte[] getBytes() {
		return bytes;
	}

	/**
	 * @param bytes
	 *            the raw bytes that represents this byte array
	 */
	public final void setBytes(byte[] bytes) {
		this.bytes = bytes;
	}

	/**
	 * @return attribute name
	 */
	@Override
	public final String toString() {
		return Constants.ATTRIBUTE_NAMES[Constants.ATTR_DEPRECATED];
	}

	/**
	 * @return deep copy of this attribute
	 */
	@Override
	public Attribute copy(ConstantPool _constant_pool) {
		Deprecated c = (Deprecated) clone();
		if (bytes != null) {
			c.bytes = new byte[bytes.length];
			System.arraycopy(bytes, 0, c.bytes, 0, bytes.length);
		}
		c.constant_pool = _constant_pool;
		return c;
	}
}
