com.flowpowered.commons.hashing.ByteShortByteHashed Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flow-commons Show documentation

A library for Java that provides re-usable components commonly used by Flow libraries.

The newest version!

/*
 * This file is part of Flow Commons, licensed under the MIT License (MIT).
 *
 * Copyright (c) 2013 Flow Powered 
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.flowpowered.commons.hashing;

public class ByteShortByteHashed {
    /**
     * Creates a long key from 2 bytes and a short
     *
     * @param key1 a byte value
     * @param key2 a short value
     * @param key3 a byte value
     *
     * @return a long which is the concatenation of key1, key2 and key3
     */
    public static int key(int key1, int key2, int key3) {
        return (key1 & 0xFF) << 24 | (key3 & 0xFF) << 16 | key2 & 0xFFFF;
    }

    /**
     * Gets the first 8-bit integer value from a long key
     *
     * @param key to get from
     *
     * @return the first 8-bit integer value in the key
     */
    public static byte key1(int key) {
        return (byte) (key >> 24);
    }

    /**
     * Gets the second 16-bit integer value from a long key
     *
     * @param key to get from
     *
     * @return the second 16-bit integer value in the key
     */
    public static short key2(int key) {
        return (short) key;
    }

    /**
     * Gets the third 8-bit integer value from a long key
     *
     * @param key to get from
     *
     * @return the third 8-bit integer value in the key
     */
    public static byte key3(int key) {
        return (byte) (key >> 16);
    }
}