org.joe_e.array
Class BooleanArray

java.lang.Object
  org.joe_e.array.ConstArray<E>
      org.joe_e.array.ImmutableArray<E>
          org.joe_e.array.PowerlessArray<Boolean>
              org.joe_e.array.BooleanArray

All Implemented Interfaces:

Serializable, Iterable<Boolean>, Immutable, Powerless, Selfless

public final class BooleanArray
extends PowerlessArray<Boolean>

An immutable array of boolean.

See Also:

Serialized Form

Nested Class Summary

static class

BooleanArray.Builder A BooleanArray factory.

Method Summary

static BooleanArray	array() Construct an empty BooleanArray
static BooleanArray	array(boolean... booleans) Constructs an array of booleans.
static BooleanArray	array(boolean value) Construct a BooleanArray with one element.
static BooleanArray	array(boolean value1, boolean value2) Construct a BooleanArray with two elements.
static BooleanArray	array(boolean value1, boolean value2, boolean value3) Construct a BooleanArray with three elements.
static BooleanArray	array(boolean value1, boolean value2, boolean value3, boolean value4) Construct a BooleanArray with four elements.
static BooleanArray.Builder	builder() Get a BooleanArray.Builder.
static BooleanArray.Builder	builder(int estimate) Get a BooleanArray.Builder.
boolean	equals(Object other) Test for equality with another object
Boolean	get(int i) Creates a Boolean for a specified boolean.
boolean	getBoolean(int i) Gets the boolean at a specified position.
int	hashCode() Computes a digest of the array for hashing.
int	length() Gets the length of the array.
<T> T[]	toArray(T[] prototype) Return a mutable copy of the array
boolean[]	toBooleanArray() Creates a mutable copy of the boolean array
String	toString() Return a string representation of the array
BooleanArray	with(boolean newBoolean) Creates a BooleanArray with an appended boolean.
BooleanArray	with(Boolean newBoolean) Creates a BooleanArray with an appended Boolean.
BooleanArray	without(int i) Return a new BooleanArray that contains the same elements as this one excluding the element at a specified index

Methods inherited from class org.joe_e.array.PowerlessArray

array

Methods inherited from class org.joe_e.array.ConstArray

iterator

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

array

public static BooleanArray array(boolean... booleans)

Constructs an array of booleans.

Parameters:

booleans - each element

array

public static BooleanArray array()

Construct an empty BooleanArray

array

public static BooleanArray array(boolean value)

Construct a BooleanArray with one element.

Parameters:

value - the value

array

public static BooleanArray array(boolean value1,
                                 boolean value2)

Construct a BooleanArray with two elements.

Parameters:

value1 - the first value

value2 - the second value

array

public static BooleanArray array(boolean value1,
                                 boolean value2,
                                 boolean value3)

Construct a BooleanArray with three elements.

Parameters:

value1 - the first value

value2 - the second value

value3 - the third value

array

public static BooleanArray array(boolean value1,
                                 boolean value2,
                                 boolean value3,
                                 boolean value4)

Construct a BooleanArray with four elements.

Parameters:

value1 - the first value

value2 - the second value

value3 - the third value

value4 - the fourth value

equals

public boolean equals(Object other)

Test for equality with another object

Overrides:

equals in class ConstArray<Boolean>

Parameters:

other - the reference object with which to compare.

Returns:

true if the other object is a ConstArray with the same contents as this array

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Computes a digest of the array for hashing. The hash code is the same as Arrays.hashCode(Object[]) called on a Java array containing the same elements.

Specified by:

hashCode in interface Selfless

Overrides:

hashCode in class ConstArray<Boolean>

Returns:

a hash code based on the contents of this array

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

Return a string representation of the array

Overrides:

toString in class ConstArray<Boolean>

Returns:

a string representation of this array

length

public int length()

Gets the length of the array.

Overrides:

length in class ConstArray<Boolean>

get

public Boolean get(int i)

Creates a Boolean for a specified boolean.

Overrides:

get in class ConstArray<Boolean>

Parameters:

i - position of the element to return

Throws:

ArrayIndexOutOfBoundsException - i is out of bounds

toArray

public <T> T[] toArray(T[] prototype)

Return a mutable copy of the array

Overrides:

toArray in class ConstArray<Boolean>

Parameters:

prototype - prototype of the array to copy into

Returns:

an array containing the contents of this ConstArray of the same type as prototype

Throws:

ArrayStoreException - if an element cannot be stored in the array

with

public BooleanArray with(Boolean newBoolean)

Creates a BooleanArray with an appended Boolean.

Overrides:

with in class PowerlessArray<Boolean>

Parameters:

newBoolean - the element to append

Returns:

the new array

Throws:

NullPointerException - newBoolean is null

getBoolean

public boolean getBoolean(int i)

Gets the boolean at a specified position.

Parameters:

i - position of the element to return

Throws:

ArrayIndexOutOfBoundsException - i is out of bounds

toBooleanArray

public boolean[] toBooleanArray()

Creates a mutable copy of the boolean array

with

public BooleanArray with(boolean newBoolean)

Creates a BooleanArray with an appended boolean.

Parameters:

newBoolean - the element to append

without

public BooleanArray without(int i)

Return a new BooleanArray that contains the same elements as this one excluding the element at a specified index

Overrides:

without in class PowerlessArray<Boolean>

Parameters:

i - the index of the element to exclude

Returns:

the new array

builder

public static BooleanArray.Builder builder()

Get a BooleanArray.Builder. This is equivalent to the constructor.

Returns:

a new builder instance, with the default internal array length

builder

public static BooleanArray.Builder builder(int estimate)

Get a BooleanArray.Builder. This is equivalent to the constructor.

Parameters:

estimate - estimated array length

Returns:

a new builder instance