io.deephaven.util.BooleanUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of deephaven-engine-query-constants Show documentation
The 'engine-query-constants' project
There is a newer version: 0.36.1
Show newest version
//
// Copyright (c) 2016-2024 Deephaven Data Labs and Patent Pending
//
package io.deephaven.util;

/**
 * Utilities for translating boxed {@link Boolean}s to/from primitive bytes.
 */
public class BooleanUtils {

    /**
     * The byte encoding of null booleans.
     */
    public static final byte NULL_BOOLEAN_AS_BYTE = QueryConstants.NULL_BYTE;

    /**
     * The byte encoding of true booleans.
     */
    public static final byte TRUE_BOOLEAN_AS_BYTE = (byte) 1;

    /**
     * The byte encoding of false booleans.
     */
    public static final byte FALSE_BOOLEAN_AS_BYTE = (byte) 0;

    /**
     * The byte encoding of the null boolean, as a boxed Byte.
     */
    public static final Byte NULL_BOOLEAN_AS_BYTE_BOXED = NULL_BOOLEAN_AS_BYTE;

    /**
     * Convert {@code byteValue} to a Boolean.
     *
     * @param byteValue the byte to convert to a boxed boolean
     *
     * @return the boxed boolean represented by byteValue
     */
    public static Boolean byteAsBoolean(final byte byteValue) {
        return byteValue == FALSE_BOOLEAN_AS_BYTE ? Boolean.FALSE : byteValue > 0 ? Boolean.TRUE : null;
    }

    /**
     * Convert {@code booleanValue} to a byte.
     *
     * @param booleanValue the boxed boolean value to convert to a byte
     *
     * @return booleanValue represented as a byte
     */
    public static byte booleanAsByte(final Boolean booleanValue) {
        return booleanValue == null ? NULL_BOOLEAN_AS_BYTE
                : booleanValue ? TRUE_BOOLEAN_AS_BYTE : FALSE_BOOLEAN_AS_BYTE;
    }

    /**
     * Convert {@code booleanValue} to a byte.
     *
     * @param booleanValue the unboxed boolean value to convert to a byte
     *
     * @return booleanValue represented as a byte
     */
    public static byte booleanAsByte(final boolean booleanValue) {
        return booleanValue ? TRUE_BOOLEAN_AS_BYTE : FALSE_BOOLEAN_AS_BYTE;
    }

    /**
     * Convert an array of {@code booleanValues} to an array of bytes.
     *
     * @param booleanArray the primitive boolean array to convert to a byte
     *
     * @return booleanArray represented as a byte array
     */
    public static byte[] booleanAsByteArray(final boolean[] booleanArray) {
        final byte[] result = new byte[booleanArray.length];
        for (int ii = 0; ii < result.length; ++ii) {
            result[ii] = booleanAsByte(booleanArray[ii]);
        }
        return result;
    }

    /**
     * Convert an array of {@code booleanValues} to an array of bytes.
     *
     * @param booleanArray the boxed boolean array to convert to a byte
     *
     * @return booleanArray represented as a byte array
     */
    public static byte[] booleanAsByteArray(final Boolean[] booleanArray) {
        final byte[] result = new byte[booleanArray.length];
        for (int ii = 0; ii < result.length; ++ii) {
            result[ii] = booleanAsByte(booleanArray[ii]);
        }
        return result;
    }
}