CExoStringData.java

// <editor-fold defaultstate="collapsed" desc="license">
/*
 * Copyright (c) 2014, Karl H. Beckers
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * * Neither the name of the <ORGANIZATION> nor the names of its contributors
 *   may be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 **/
// </editor-fold>
package net.jarre_de_the.griffin.types.data;

import java.io.IOException;
import java.io.RandomAccessFile;
import java.util.Arrays;
import net.jarre_de_the.griffin.Util;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Implementation of CEXOSTRING. The GFF CEXOSTRING physically consists of a
 * DWORD for the string length, and as many bytes as stated in length.
 *
 * @author charly4711
 */
public class CExoStringData extends AbstractData
        implements Cloneable {

    private static final Logger LOGGER = LoggerFactory.getLogger(CExoStringData.class);
    private byte[] value;

    public static final int MAX_LENGTH = 1024;

    /*
     *
     * constructors
     *
     */
    protected CExoStringData() {
    }

    /**
     * Creates a new instance of {@code CExoStringData} and sets the defined
     * value. A buffer longer than MAX_LENGTH will be truncated.
     *
     * @param buf String contents as a byte array.
     * @see #setValue(byte[])
     */
    public CExoStringData(byte[] buf) {
        setValue(buf);
    }

    /*
     *
     * read from file
     *
     */
    /**
     * Creates a new instance of {@code CExoStringData} based on the data read from
     * the file passed. Note that the contents are read from whatever position
     * the file pointer is at.
     * <p>
     * @param in An open {@code RandomAccessFile}.
     * @return
     * @throws java.io.IOException If there are any I/O related problems with
     * file access to in.
     */
    public static CExoStringData read(RandomAccessFile in)
            throws IOException {
        LOGGER.debug("Reading CExoStringData from file.");
        // first read length
        DWordData len = DWordData.read(in);
        LOGGER.trace("Need to read " + len.getValueAsNumber() + " bytes");
        // then read as much content as needed
        // we're just hoping we'll never encounter a GFF file where a
        // single buffer is > MAXINT
        byte[] buf = new byte[len.getValueAsNumber().intValue()];
        in.readFully(buf);
        LOGGER.debug("Read: " + new String(buf, Util.CHARSET_US_ASCII));
        return new CExoStringData(buf);
    }

    /*
     *
     * setter
     *
     */
    /**
     * Sets the value of this instance. The byte array is copied internally.
     *
     * @param buf The byte array containing the string. If the length of the
     * byte array exceeds MAX_LENGTH it will be truncated.
     */
    private void setValue(byte[] buf) {
        if (buf != null) {
            int len = buf.length;
            if (len > MAX_LENGTH) {
                len = MAX_LENGTH;
            }
            this.value = new byte[len];
            System.arraycopy(buf, 0, this.value, 0, len);
        }
    }

    /*
     *
     * getter
     *
     */
    /**
     * Returns this instance's bit-field value as a byte array in the same order
     * it would be stored in a GFF file. Note, this does not prepend the length.
     *
     * @return This instance's value as a bit field of variable length.
     */
    public byte[] getValueAsByteArray() {
        byte[] buf;
        if (null != value) {
            buf = new byte[value.length];
            System.arraycopy(value, 0, buf, 0, value.length);
        } else {
            buf = null;
        }
        return buf;
    }

    /*
     *
     * utility
     *
     */
    /**
     * Overrides the {@code java.lang.Object} method to ensure we always get
     * back an instance of {@code CExoStringData} rather than just
     * {@code Object}.
     *
     * @return A deep copy of this object.
     * @throws java.lang.CloneNotSupportedException
     */
    @Override
    public CExoStringData clone() throws CloneNotSupportedException {
        LOGGER.debug("Cloning object");
        CExoStringData clone = (CExoStringData) super.clone();
        clone.setValue(value); // setValue does an arraycopy

        return clone;
    }

    /**
     * Overrides the {@code java.lang.Object} method to make test for equality
     * possible for this class.
     *
     * @param compare The Object to compare this object with.
     * @return True if the objects have the same value, false if not.
     */
    @Override
    public boolean equals(Object compare) {
        if (compare == this) {
            return true;
        }

        if (!(compare instanceof CExoStringData)) {
            return false;
        }

        CExoStringData d = (CExoStringData) compare;
        return Arrays.equals(d.getValueAsByteArray(), this.getValueAsByteArray());
    }

    /**
     * Overrides the {@code java.lang.Object} method to ensure we have a hash
     * code consistent with the test for equality.
     *
     * @return The hash returned is based on the value.
     */
    @Override
    public int hashCode() {
        return Arrays.hashCode(value);
    }

    /**
     * Get this instance's value as a Java String.
     *
     * @return
     */
    @Override
    public String toString() {
        return new String(getValueAsByteArray(), Util.CHARSET_US_ASCII);
    }
}