/*\
* Copyright 2006 Klaus Rogall, Hamburg, Germany (klaus.rogall@web.de). All rights reserved.
* _____________________________________________________________________________________________________________________
*
* This class is "Open Source" as defined by the Open Source Initiative (OSI). You can redistribute it and/or modify it
* under the terms of the BSD License. The license text is appended to the end of this file.
\*/
package de.klaro.base.util;
/**
* Methoden zur Verarbeitung von Bits und Biz-Feldern.
*/
public class Bits extends Object
{
/* ______________________________________________________________________________________________________________ *\
\* Konstanten */
/* ______________________________________________________________________________________________________________ *\
\* Klassenvariablen */
/* ______________________________________________________________________________________________________________ *\
\* Instanzvariablen */
/* ______________________________________________________________________________________________________________ *\
\* Konstruktoren */
/**
* Erzeugt eine Instanz dieser Klasse.
*
* Da verhindert werden soll, dass Instanzen dieser Klasse ausserhalb dieser Klasse erzeugt werdem, ist dieser
* Konstruktor 'private' deklariert.
*/
private Bits()
{
super();
}
/* ______________________________________________________________________________________________________________ *\
\* Instanzmethoden */
/* ______________________________________________________________________________________________________________ *\
\* Klassenmethoden */
/**
* Liefert eine Bit-codierte Zahl, in der ein einziges Bit gesetzt ist.
*
* Die Position des Bits muss im Bereich 0 bis 31 (einschliesslich) liegen.
*
* @param position Die Position des Bits, das gesetzt sein soll
* @return Die Bit-codierte Zahl
*/
public static int bit(int position)
{
if (position < 0 || position > 31)
throw new IllegalArgumentException("position not within range 0 to 31");
return 1 << position;
}
/**
* Setzt in der bergebenen Bit-codierten Zahl ein weiteres Bit.
*
* Die Position des Bits muss im Bereich 0 bis 31 (einschliesslich) liegen.
*
* @param bits Die Bit-codierte Zahl
* @param position Die Position des Bits, das gesetzt sein soll
* @return Die Bit-codierte Zahl
*/
public static int set(int bits,int position)
{
if (position < 0 || position > 31)
throw new IllegalArgumentException("position not within range 0 to 31");
return bits | (1 << position);
}
/**
* Lscht in der bergebenen Bit-codierten Zahl ein weiteres Bit.
*
* Die Position des Bits muss im Bereich 0 bis 31 (einschliesslich) liegen.
*
* @param bits Die Bit-codierte Zahl
* @param position Die Position des Bits, das gesetzt sein soll
* @return Die Bit-codierte Zahl
*/
public static int clear(int bits,int position)
{
if (position < 0 || position > 31)
throw new IllegalArgumentException("position not within range 0 to 31");
return bits & ~(1 << position);
}
/**
* ndert in der bergebenen Bit-codierten Zahl das angegebene Bit auf den gegenteiligen Wert.
*
* Die Position des Bits muss im Bereich 0 bis 31 (einschliesslich) liegen.
*
* @param bits Die Bit-codierte Zahl
* @param position Die Position des Bits, das gesetzt sein soll
* @return Die Bit-codierte Zahl
*/
public static int flip(int bits,int position)
{
if (position < 0 || position > 31)
throw new IllegalArgumentException("position not within range 0 to 31");
return bits ^ (1 << position);
}
/**
* Prft, ob das Bit an einer bestimmten einer Bit-codierten Zahl gesetzt ist.
*
* Die Position des Bits muss im Bereich 0 bis 31 (einschliesslich) liegen.
*
* @param bits Die Bit-codierte Zahl
* @param position Die Position des Bits, das geprft werden sein soll
* @return Das Bit ist gesetzt
*/
public static boolean isSet(int bits,int position)
{
if (position < 0 || position > 31)
throw new IllegalArgumentException("position not within range 0 to 31");
return ((bits & (1 << position)) != 0);
}
/**
* Prft, ob das Bit an einer bestimmten einer Bit-codierten Zahl gelscht ist.
*
* Die Position des Bits muss im Bereich 0 bis 31 (einschliesslich) liegen.
*
* @param bits Die Bit-codierte Zahl
* @param position Die Position des Bits, das geprft werden sein soll
* @return Das Bit ist gelscht
*/
public static boolean isCleared(int bits,int position)
{
if (position < 0 || position > 31)
throw new IllegalArgumentException("position not within range 0 to 31");
return ((bits | (1 << position)) == 0);
}
/* ______________________________________________________________________________________________________________ *\
\* Klassen */
}
/*\
* _____________________________________________________________________________________________________________________
*
* This software is distributed under the terms of the BSD License:
*
* Copyright 2006 Klaus Rogall, Hamburg, Germany (klaus.rogall@web.de). All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer.
* - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the distribution.
* - Neither the name of the Klaus Rogall nor the names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* _____________________________________________________________________________________________________________________
\*/
