com.io7m.jintegers.Unsigned32 Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2014  http://io7m.com
 * 
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package com.io7m.jintegers;

import com.io7m.jnull.NullCheck;
import com.io7m.junreachable.UnreachableCodeException;

import java.nio.ByteBuffer;

/**
 * Unsigned 32-bit integer handling.
 */

public final class Unsigned32
{
  private Unsigned32()
  {
    throw new UnreachableCodeException();
  }

  /**
   * Unpack an unsigned 32-bit integer from the buffer.
   *
   * @param data  The buffer.
   * @param index The starting index.
   *
   * @return An unpacked integer value.
   */

  public static long unpackFromBuffer(
    final ByteBuffer data,
    final int index)
  {
    NullCheck.notNull(data, "Buffer");
    final long x = data.getInt(index);
    return (x & 0xffffffffL);
  }

  /**
   * Pack an unsigned 32-bit integer into the buffer.
   *
   * @param x     The value.
   * @param data  The buffer.
   * @param index The starting index.
   */

  public static void packToBuffer(
    final long x,
    final ByteBuffer data,
    final int index)
  {
    NullCheck.notNull(data, "Buffer");
    data.putInt(index, (int) (x & 0xffffffffL));
  }
}