com.igormaznitsa.jbbp.io.JBBPBitNumber Maven / Gradle / Ivy

Go to download

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

JBBP (Java Binary Block Parser) is a small lightweight framework to parse binary data in Java, it has own DSL to describe parsing data format

There is a newer version: 3.0.1

Show newest version

/*
 * Copyright 2017 Igor Maznitsa.
 *
 * 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.igormaznitsa.jbbp.io;

/**
 * Constants allowed bit numbers for bit operations.
 *
 * @since 1.0
 */
public enum JBBPBitNumber {

  /**
   * One bit.
   */
  BITS_1(1, 0x01),
  /**
   * Two bits.
   */
  BITS_2(2, 0x03),
  /**
   * Three bits.
   */
  BITS_3(3, 0x07),
  /**
   * Four bits.
   */
  BITS_4(4, 0x0F),
  /**
   * Five bits.
   */
  BITS_5(5, 0x1F),
  /**
   * Six bits.
   */
  BITS_6(6, 0x3F),
  /**
   * Seven bits.
   */
  BITS_7(7, 0x7F),
  /**
   * Eight bits.
   */
  BITS_8(8, 0xFF);

  /**
   * Number of bits.
   */
  private final int numberOfBits;
  /**
   * Mask for the number of bits.
   */
  private final int mask;

  JBBPBitNumber(final int numberOfBits, final int mask) {
    this.numberOfBits = numberOfBits;
    this.mask = mask;
  }

  /**
   * Decode a numeric value to a constant.
   *
   * @param numberOfBits the numeric value to be decoded
   * @return decoded constant
   * @throws IllegalArgumentException if the value less than 1 or greater than 8
   */
  public static JBBPBitNumber decode(final int numberOfBits) {
    if (numberOfBits <= 0 || numberOfBits > 8) {
      throw new IllegalArgumentException("Unsupported bit number, allowed 1..8");
    }
    return values()[numberOfBits - 1];
  }

  /**
   * Get the mask for the number of bits.
   *
   * @return the mask for the number of bits
   */
  public int getMask() {
    return this.mask;
  }

  /**
   * Get the numeric value of the bit number.
   *
   * @return the number of bits as integer
   */
  public int getBitNumber() {
    return this.numberOfBits;
  }
}