me.jamiemansfield.lorenz.io.kin.KinConstants Maven / Gradle / Ivy

Go to download
/*
 * This file is part of Lorenz, licensed under the MIT License (MIT).
 *
 * Copyright (c) Jamie Mansfield 
 * Copyright (c) contributors
 *
 * 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 me.jamiemansfield.lorenz.io.kin;

/**
 * A collection of constants specific to the Kin mapping
 * format.
 *
 * @author Jamie Mansfield
 * @since 0.4.0
 */
public final class KinConstants {

    /**
     * The magic marker for Kin files.
     */
    public static final int MAGIC = 0x5e8f046;

    /**
     * The marker for version 1 of the Kin format.
     */
    public static final byte VERSION_ONE = (byte) 1;

    /**
     * The standard file extension used with the Kin format.
     */
    public static final String STANDARD_EXTENSION = "kin";

    /**
     * Coverts the given integer to a Kin-compatible hexadecimal
     * format.
     *
     * @param integer The integer to convert
     * @return The hexadecimal string
     */
    public static String toHexString(final int integer) {
        return "0x" + Integer.toHexString(integer);
    }

    private KinConstants() {
    }

}