CharData.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 net.jarre_de_the.griffin.Util;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Implementation of the CHAR data type. A GFF CHAR is a single signed byte and can hold values from -128 to 127. It is
 * mostly used for ASCII characters.
 * <p>
 * @author charly4711
 */
public class CharData extends AbstractFixedLengthData<Byte, CharData>
        implements NumberData<Byte>, Cloneable {

    public static final int LENGTH = 2;
    private static final Logger LOGGER = LoggerFactory.getLogger(CharData.class);
    private byte value = (byte) 0;

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

    /**
     * Creates a new new instance of {@code CharData} and sets a defined value.
     * <p>
     * @param b The value to set. Note how this uses a Java byte not a char, because the byte is signed as is the CHAR.
     * @see #setValue(byte b)
     */
    public CharData(byte b) {
        setValue(b);
    }

    /*
     *
     * read from file
     *
     */
    /**
     * Creates a new instance of {@code CharData} 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 CharData read(RandomAccessFile in)
            throws IOException {
        return new CharData((byte)read(in, Byte.class));
    }

    /*
     *
     * setter
     *
     */
    /**
     * Sets this instance's value.
     * <p>
     * @param b The value to set. Note how this uses a Java byte not a char, because the byte is signed as is the CHAR
     *          and a Java char is 16 bit.
     */
    private void setValue(byte b) {
        value = b;
    }

    /*
     *
     * getter
     *
     */
    /**
     * Retrieves this instance's value as a Java long.
     * <p>
     * @return The value of this instance.
     */
    @Override
    public Byte getValueAsNumber() {
        return value;
    }

    @Override
    public byte[] getValueAsByteArray() {
        return super.getValueAsByteArray(value);
    }

    @Override
    public Byte getValue() {
        return value;
    }

    /*
     *
     * utility
     *
     */
    @Override
    public int length() {
        return LENGTH;
    }

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

        return clone;
    }

    @Override
    public boolean equals(Object compare) {
        if (compare == this) {
            return true;
        }

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

        CharData d = (CharData) compare;
        return d.getValueAsNumber().equals(this.getValueAsNumber());
    }

    @Override
    public int hashCode() {
        int code = 0;
        int mask = Integer.parseInt("11000000", 2);
        code |= (value & mask) << 24;
        mask = Integer.parseInt("00110000", 2);
        code |= (value & mask) << 16;
        mask = Integer.parseInt("00001100", 2);
        code |= (value & mask) << 8;
        mask = Integer.parseInt("00000011", 2);
        code |= (value & mask);

        return code;
    }

    @Override
    public String toString() {
        byte[] buf = new byte[1];
        buf[0] = value;
        return new String(buf, Util.CHARSET_US_ASCII);
    }
}