Module coneforest.psylla

Package coneforest.psylla.core

Interface PsyBitwise<T extends PsyBitwise>

Type Parameters:

T - a type of the second operand at binary operations.

All Superinterfaces:

PsyLogical<T>, PsyObject

All Known Subinterfaces:

PsyIntegral

All Known Implementing Classes:

PsyBigInteger, PsyBitArray, PsyInteger

@Type("bitwise")
public interface PsyBitwise<T extends PsyBitwise>
extends PsyLogical<T>

The representation of bitwise, a type of object that is an operand of bitwise operation. This interface declares methods for setting, clearing, testing of certain bits and bitwise shift.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_BITSHIFT	Context action of the bitshift operator.
static final ContextAction	PSY_CLEARBIT	Context action of the clearbit operator.
static final ContextAction	PSY_FLIPBIT	Context action of the flipbit operator.
static final ContextAction	PSY_SETBIT	Context action of the setbit operator.
static final ContextAction	PSY_TESTBIT	Context action of the testbit operator.

Fields inherited from interface coneforest.psylla.core.PsyLogical

PSY_AND, PSY_NOT, PSY_OR, PSY_XOR

Fields inherited from interface coneforest.psylla.core.PsyObject

PSY_CLONE, PSY_EQ, PSY_HASHCODE, PSY_INSTANCEOF, PSY_NE, PSY_TONAME, PSY_TOSTRING, PSY_TYPE

Method Summary

Modifier and Type	Method	Description
PsyBitwise	psyBitShift(PsyInteger oShift)	Returns a bitwise whose value is equivalent to this value with bits shifted at the given distance.
PsyBitwise	psyClearBit(PsyInteger oBit)	Returns a bitwise whose value is equivalent to this value with the designated bit cleared.
PsyBitwise	psyFlipBit(PsyInteger oBit)	Returns a bitwise whose value is equivalent to this value with the designated bit flipped.
PsyBitwise	psySetBit(PsyInteger oBit)	Returns a bitwise whose value is equivalent to this value with the designated bit set.
PsyBoolean	psyTestBit(PsyInteger oBit)	Returns a boolean indicating if the designated bit is set.

Methods inherited from interface coneforest.psylla.core.PsyLogical

psyAnd, psyNot, psyOr, psyXor

Methods inherited from interface coneforest.psylla.core.PsyObject

convert, execute, invoke, psyClone, psyEq, psyHashCode, psyInstanceOf, psyNe, psySyntax, psyToName, psyToString, psyType, toSyntaxString, typeName

Field Details

PSY_BITSHIFT

@OperatorType("bitshift")
static final ContextAction PSY_BITSHIFT

Context action of the bitshift operator.

PSY_CLEARBIT

@OperatorType("clearbit")
static final ContextAction PSY_CLEARBIT

Context action of the clearbit operator.

PSY_FLIPBIT

@OperatorType("flipbit")
static final ContextAction PSY_FLIPBIT

Context action of the flipbit operator.

PSY_SETBIT

@OperatorType("setbit")
static final ContextAction PSY_SETBIT

Context action of the setbit operator.

PSY_TESTBIT

@OperatorType("testbit")
static final ContextAction PSY_TESTBIT

Context action of the testbit operator.

Method Details

psyClearBit

PsyBitwise psyClearBit(PsyInteger oBit)
                throws PsyRangeCheckException

Returns a bitwise whose value is equivalent to this value with the designated bit cleared.

Parameters:

oBit - the index of bit to clear.

Returns:

a bitwise whose value is equivalent to this value with the designated bit cleared.

Throws:

PsyRangeCheckException - if the index is out of range.

psyFlipBit

PsyBitwise psyFlipBit(PsyInteger oBit)
               throws PsyRangeCheckException

Returns a bitwise whose value is equivalent to this value with the designated bit flipped.

Parameters:

oBit - the index of bit to flip.

Returns:

a bitwise whose value is equivalent to this value with the designated bit flipped.

Throws:

PsyRangeCheckException - if the index is out of range.

psySetBit

PsyBitwise psySetBit(PsyInteger oBit)
              throws PsyRangeCheckException

Returns a bitwise whose value is equivalent to this value with the designated bit set.

Parameters:

oBit - the index of bit to set.

Returns:

a bitwise whose value is equivalent to this value with the designated bit set.

Throws:

PsyRangeCheckException - if the index is out of range.

psyTestBit

PsyBoolean psyTestBit(PsyInteger oBit)
               throws PsyRangeCheckException

Returns a boolean indicating if the designated bit is set.

Parameters:

oBit - the index of bit to test.

Returns:

a boolean indicating if the designated bit set.

Throws:

PsyRangeCheckException - if the index is out of range.

psyBitShift

PsyBitwise psyBitShift(PsyInteger oShift)

Returns a bitwise whose value is equivalent to this value with bits shifted at the given distance. If the distance is negative, the left shift is preformed. If the distance is positive, the right shift is preformed. If the distance is zero, returns this.

Parameters:

oShift - the shift distance.

Returns:

a bitwise whose value is equivalent to this value with bits shifted at the given distance.