Class Device

java.lang.Object

Device

public class Device
extends Object

Resource-locking device with circular bit storage.

Version:

1.2.5.1

Author:

Dr. Jody Paul

See Also:

Project Description

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PEEKS Default number of bits to reveal per peek.
static int	DEFAULT_SIZE Default number of bits stored.
static char	VALUE_FALSE Character indicator of false.
static char	VALUE_TRUE Character indicator of true.

Constructor Summary

Constructors

Constructor and Description
Device() Construct device using defaults.
Device(boolean[] initialBits, int bitsPerPeek) Construct device with specified bits for testing.
Device(int size, int bitsPerPeek) Construct device with specified size and number of peek/poke bits.

Method Summary

Modifier and Type	Method and Description
CharSequence	peek(CharSequence pattern) Peek at bits of device.
void	poke(CharSequence pattern) Poke bits into device.
boolean	spin() Initiate device rotation.
String	toString() Render device information as a string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SIZE

public static final int DEFAULT_SIZE

Default number of bits stored.

See Also:

Constant Field Values

DEFAULT_PEEKS

public static final int DEFAULT_PEEKS

Default number of bits to reveal per peek.

See Also:

Constant Field Values

VALUE_TRUE

public static final char VALUE_TRUE

Character indicator of true.

See Also:

Constant Field Values

VALUE_FALSE

public static final char VALUE_FALSE

Character indicator of false.

See Also:

Constant Field Values

Constructor Detail

Device

public Device()

Construct device using defaults.

Device

public Device(int size,
              int bitsPerPeek)

Construct device with specified size and number of peek/poke bits.

Parameters:

size - the number of bits stored in this device

bitsPerPeek - the number of bits to disclose via peek or set via poke

Device

public Device(boolean[] initialBits,
              int bitsPerPeek)

Construct device with specified bits for testing. Initial bit values are represented by an array of boolean primitives.

Parameters:

initialBits - the bit values for this test device

bitsPerPeek - the number of bits to disclose via peek or set via poke

Method Detail

spin

public boolean spin()

Initiate device rotation.

Returns:

true if all bits have identical value; false otherwise

peek

public CharSequence peek(CharSequence pattern)

Peek at bits of device.

Parameters:

pattern - indicates which bits to reveal as '?'. pattern.length() must be exactly equal to the number of bits stored in the device.

Returns:

a pattern that discloses the values of the indicated bits as 'T' or 'F'

poke

public void poke(CharSequence pattern)

Poke bits into device.

Parameters:

pattern - indicator of values of bits to poke. pattern.length() must be exactly equal to the number of bits stored in the device. Values of 'T' or 'F' that correspond to '?' in the preceding peek request pattern replace the values in the device.

toString

public String toString()

Render device information as a string.

Overrides:

toString in class Object

Returns:

rendering that reveals partial state