com.zackehh.siphash.SipHashResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of siphash Show documentation
A SipHash implementation in Java.
The newest version!
package com.zackehh.siphash;

import org.apache.commons.lang3.StringUtils;

import static com.zackehh.siphash.SipHashConstants.DEFAULT_CASE;
import static com.zackehh.siphash.SipHashConstants.DEFAULT_PADDING;

/**
 * A container class of the result of a hash. This class exists
 * to allow the developer to retrieve the result in any format
 * they like. Currently available formats are `long` and ${@link java.lang.String}.
 * When retrieving as a String, the developer can specify the case
 * they want it in, and whether or not we should pad the left side
 * to 16 characters with 0s.
 */
public class SipHashResult {

    /**
     * The internal hash result.
     */
    private final long result;

    /**
     * A package-private constructor, as only
     * SipHash should be creating results.
     *
     * @param result the result of a hash
     */
    SipHashResult(long result){
        this.result = result;
    }

    /**
     * Simply returns the hash result as a long.
     *
     * @return the hash value as a long
     */
    public long get(){
        return result;
    }

    /**
     * Returns the result as a Hex String, using
     * the default padding and casing values.
     *
     * @return the hash value as a Hex String
     */
    public String getHex(){
        return getHex(DEFAULT_PADDING, DEFAULT_CASE);
    }

    /**
     * Returns the result as a Hex String, using
     * a custom padding value and default casing value.
     *
     * @param padding whether or not to pad the string
     * @return the hash value as a Hex String
     */
    public String getHex(boolean padding){
        return getHex(padding, DEFAULT_CASE);
    }

    /**
     * Returns the result as a Hex String, using
     * a default padding value and custom casing value.
     *
     * @param s_case the case to convert the output to
     * @return the hash value as a Hex String
     */
    public String getHex(SipHashCase s_case){
        return getHex(DEFAULT_PADDING, s_case);
    }

    /**
     * Returns the result as a Hex String, taking in
     * various arguments to customize the output further,
     * such as casing and padding.
     *
     * @param padding whether or not to pad the string
     * @param s_case the case to convert the output to
     * @return a Hex String in the custom format
     */
    public String getHex(boolean padding, SipHashCase s_case){
        String str = Long.toHexString(get());
        if (padding) {
            str = StringUtils.leftPad(str, 16, "0");
        }
        if (s_case == SipHashCase.UPPER) {
            str = str.toUpperCase();
        }
        return str;
    }
}