org.lable.oss.bitsandbytes.Hex Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of bitsandbytes Show documentation

A motley collection of utility classes that perform a variety of potentially useful operations on bits, bytes, and strings representing them.

There is a newer version: 4.3

Show newest version

/*
 * Copyright (C) 2015 Lable ([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.lable.oss.bitsandbytes;

/**
 * Convert hexadecimal string representations to byte arrays and vice versa.
 */
public class Hex {
    Hex() {
        // Static utility class.
    }

    /**
     * Convert a hexadecimal string representation of a byte array to that byte array. This method purposely ignores any
     * characters that are not part of {@code 0-9A-Fa-f}, so you can use spaces and any other punctuation deemed
     * suitable to improve readability.
     * 
     * The following input strings all return the same byte array:
     * 

     * "CAFEBABE"
     * "CAFE_BABE"
     * "[CAFE] [BABE]"
     * "cafebabe"
     * "0xCAFEBABE"
     * 
     *
     * @param hexadecimal Input string.
     * @return The corresponding byte array.
     */
    public static byte[] decode(String hexadecimal) {
        return ByteVisualization.HEXADECIMAL.parse(hexadecimal);
    }

    /**
     * Encode a byte array as its hexadecimal string representation.
     *
     * @param input Input byte array.
     * @return A hexadecimal string, or "NULL" if the input is null.
     */
    public static String encode(byte[] input) {
        return ByteVisualization.HEXADECIMAL.visualize(input);
    }
}