WordData.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.exception.ValueTooLargeException;
import net.jarre_de_the.griffin.exception.ValueTooSmallException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Implementation of the WORD. A GFF WORD is 2 bytes unsigned integer. The range of possible values is 0 to 65535.
 * <p>
 * @author charly4711
 */
public class WordData
        extends AbstractFixedLengthData<Short, WordData>
        implements NumberData<Integer>, Cloneable {

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

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

    /**
     * Creates a new instance of {@code WordData} and sets a defined value.
     * <p>
     * @param s The value to set. The Java primitve short is a signed 16 bit integer. Only pass it as a bit-field.
     * @see #setValue(short s)
     */
    public WordData(short s) {
        setValue(s);
    }

    public WordData(int i) {
        setValue(i);
    }

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

    /*
     *
     * setter
     *
     */
    /**
     * Sets this instance's value.
     * <p>
     * @param s The value to set. The Java primitve short is a signed 16 bit integer whereas the WORD is unsigned. Only
     *          pass it as a bit-field.
     */
    private void setValue(short s) {
        value = s;
    }

    private void setValue(int i) {
        if (i < 0) {
            throw new ValueTooSmallException(0, i);
        } else if (i > (Math.pow(2, (8 * LENGTH)) - 1)) {
            throw new ValueTooLargeException((long)(Math.pow(2, (8 * LENGTH)) - 1), i);
        }
        value = (short) i;
    }

    /*
     *
     * getter
     *
     */
    /**
     * Retrieves this instance's value as a Java long.
     * <p>
     * @return This instance's value.
     */
    @Override
    public Integer getValueAsNumber() {
        int result = 0;
        result |= value;
        int mask = Integer.parseInt("0000FFFF", 16);
        result &= mask;
        return result;
    }

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

    @Override
    public byte[] getValueAsByteArray() {
        return super.getValueAsByteArray(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 WordData} rather
     * than just {@code Object}.
     * <p>
     * @return A deep copy of this object.
     * @throws java.lang.CloneNotSupportedException
     */
    @Override
    public WordData clone() throws CloneNotSupportedException {
        LOGGER.debug("Cloning object");
        WordData clone = (WordData) super.clone();
        clone.setValue(this.getValue());

        return new WordData(this.getValue());
    }

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

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

        WordData dw = (WordData) compare;
        return dw.getValue().equals(this.getValue());
    }

    @Override
    public int hashCode() {
        return value;
    }

    @Override
    public String toString() {
        return Short.toString(getValue());
    }
}