com.oceanbase.clogproxy.common.util.Hex Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oblogclient-common Show documentation
Common Utils for OceanBase Log Client.
The newest version!
/*
 * Copyright 2024 OceanBase.
 *
 * 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 com.oceanbase.clogproxy.common.util;

import io.netty.buffer.ByteBufUtil;
import io.netty.buffer.Unpooled;
import org.apache.commons.codec.DecoderException;

/** This class is used to convert hexadecimal strings. */
public final class Hex {

    /**
     * Returns a multi-line hexadecimal dump of the array that is easy to read by humans.
     *
     * @param array An array of bytes
     * @return A multi-line hexadecimal dump string
     */
    public static String dump(byte[] array) {
        return dump(array, 0, array.length);
    }

    /**
     * Returns a multi-line hexadecimal dump of the specified sub-region of bytes that is easy to
     * read by humans.
     *
     * @param bytes An array of bytes
     * @param offset The offset of the sub-region start position
     * @param length The length of the sub-region
     * @return A multi-line hexadecimal dump string
     */
    public static String dump(byte[] bytes, int offset, int length) {
        return ByteBufUtil.prettyHexDump(Unpooled.wrappedBuffer(bytes, offset, length));
    }

    /**
     * Converts an array of bytes into a string representing the hexadecimal values of each byte in
     * order.
     *
     * @param bytes An array of bytes
     * @return A String containing uppercase hexadecimal characters
     */
    public static String str(byte[] bytes) {
        return org.apache.commons.codec.binary.Hex.encodeHexString(bytes, false);
    }

    /**
     * Converts a String representing hexadecimal values into an array of bytes of those same
     * values.
     *
     * @param hexStr A String representing hexadecimal values
     * @return An array of bytes
     */
    public static byte[] toBytes(String hexStr) {
        try {
            return org.apache.commons.codec.binary.Hex.decodeHex(hexStr);
        } catch (DecoderException e) {
            return null;
        }
    }
}