Package com.github.tommyettinger.ds

Class BooleanDeque

java.lang.Object
com.github.tommyettinger.ds.BooleanList
com.github.tommyettinger.ds.BooleanDeque
All Implemented Interfaces:
Arrangeable, Ordered.OfBoolean, PrimitiveCollection<Boolean>, PrimitiveCollection.OfBoolean, RandomAccess
public class BooleanDeque extends BooleanList implements RandomAccess, Arrangeable, PrimitiveCollection.OfBoolean, Ordered.OfBoolean
A resizable, insertion-ordered double-ended queue of primitive boolean with efficient add and remove at the beginning and end. This extends BooleanList and supports RandomAccess. Like BooleanList, it is a PrimitiveCollection.OfBoolean, Arrangeable, and Ordered.OfBoolean. Values in the backing array may wrap back to the beginning, making add and remove at the beginning and end O(1) (unless the backing array needs to resize when adding). Deque functionality is provided via removeLast() and addFirst(boolean).
Unlike most Deque implementations in the JDK, you can get and set items anywhere in the deque in constant time with get(int) and set(int, boolean). Relative to a BooleanList, get(int) has slightly higher overhead, but it still runs in constant time. Unlike ArrayDeque in the JDK, this implements equals(Object) and hashCode(). This can provide what are effectively ListIterators for iteration from an index or in reverse order.
Unlike ArrayDeque or ArrayList, most methods that take an index here try to be "forgiving;" that is, they treat negative indices as index 0, and too-large indices as the last index, rather than throwing an Exception, except in some cases where the BooleanDeque is empty and an item from it is required. An exception is in set(int, boolean), which allows prepending by setting a negative index, or appending by setting a too-large index. This isn't a standard JDK behavior, and it doesn't always act how Deque or List is documented.
Some new methods are present here, or have been made public when they weren't before. removeRange(int, int), for instance, is now public, as is resize(int). New APIs include Deque-like methods that affect the middle of the deque, such as peekAt(int) and pollAt(int). There are more bulk methods that work at the head or tail region of the deque, such as addAllFirst(OfBoolean) and truncateFirst(int). There are the methods from Arrangeable, and many default methods from PrimitiveCollection and Ordered.
In general, this is an improvement over ArrayDeque in every type of functionality, and is mostly equivalent to BooleanList as long as the performance of get(int) is adequate. Because it is array-backed, it should usually be much faster than LinkedList, as well; only periodic resizing and modifications in the middle of the List using an iterator should be typically faster for LinkedList.

  • Field Details

    • defaultValue

      public boolean defaultValue
      The value returned when nothing can be obtained from this deque and an exception is not meant to be thrown, such as when calling peek() on an empty deque.

    • tail

      protected int tail
      Index of last element. Logically bigger than head. Unless empty, it points to a valid element inside the deque. This may be the same as head, and is if there is one element in the deque (or none), that will be the case.

    • descendingIterator1

      protected transient BooleanDeque.BooleanDequeIterator descendingIterator1

    • descendingIterator2

      protected transient BooleanDeque.BooleanDequeIterator descendingIterator2

  • Constructor Details

    • BooleanDeque

      public BooleanDeque()
      Creates a new BooleanDeque which can hold 16 values without needing to resize the backing array.

    • BooleanDeque

      public BooleanDeque(int initialSize)
      Creates a new BooleanDeque which can hold the specified number of values without needing to resize the backing array.
      Parameters:
      initialSize - how large the backing array should be, without any padding

    • BooleanDeque

      public BooleanDeque(PrimitiveCollection.OfBoolean coll)
      Creates a new BooleanDeque using all the contents of the given Collection.
      Parameters:
      coll - a Collection of boolean that will be copied into this and used in full
      Throws:
      NullPointerException - if coll is null

    • BooleanDeque

      public BooleanDeque(BooleanIterator iter)
      Creates a new instance containing the items in the specified iterator.
      Parameters:
      iter - an iterator that will have its remaining contents added to this
      Throws:
      NullPointerException - if iter is null

    • BooleanDeque

      public BooleanDeque(BooleanDeque deque)
      Copies the given BooleanDeque exactly into this one. Individual values will be shallow-copied.
      Parameters:
      deque - another BooleanDeque to copy
      Throws:
      NullPointerException - if deque is null

    • BooleanDeque

      public BooleanDeque(Ordered.OfBoolean other, int offset, int count)

    • BooleanDeque

      public BooleanDeque(boolean[] a)
      Creates a new BooleanDeque using all the contents of the given array.
      Parameters:
      a - an array of boolean that will be copied into this and used in full
      Throws:
      NullPointerException - if a is null

    • BooleanDeque

      public BooleanDeque(boolean[] a, int offset, int count)
      Creates a new BooleanDeque using count items from a, starting at offset. If count is 0 or less, this will create an empty BooleanDeque with capacity 1.
      Parameters:
      a - an array of boolean
      offset - where in a to start using items
      count - how many items to use from a
      Throws:
      NullPointerException - if a is null

    • BooleanDeque

      public BooleanDeque(Ordered.OfBoolean other)

  • Method Details

    • order

      public BooleanDeque order()
      Description copied from class: BooleanList
      Returns this BooleanList, since it is its own order. This is only here to satisfy the Ordered.OfBoolean interface.
      Specified by:
      order in interface Ordered.OfBoolean
      Overrides:
      order in class BooleanList
      Returns:
      this BooleanList

    • getDefaultValue

      public boolean getDefaultValue()
      Gets the default value, which is the value returned when nothing can be obtained from this deque and an exception is not meant to be thrown, such as when calling peek() on an empty deque. Unless changed, the default value is usually null.
      Returns:
      the current default value

    • setDefaultValue

      public void setDefaultValue(boolean defaultValue)
      Sets the default value, which is the value returned when nothing can be obtained from this deque and an exception is not meant to be thrown, such as when calling peek() on an empty deque. Unless changed, the default value is usually null.
      Parameters:
      defaultValue - any boolean this can return instead of throwing an Exception, or null

    • addLast

      public void addLast(boolean value)
      Appends given boolean to the tail (enqueue to tail). Unless the backing array needs resizing, operates in O(1) time.
      Parameters:
      value - can be null

    • addLast

      public void addLast(boolean value1, boolean value2)

    • addLast

      public void addLast(boolean value1, boolean value2, boolean value3)

    • addLast

      public void addLast(boolean value1, boolean value2, boolean value3, boolean value4)

    • addFirst

      public void addFirst(boolean value)
      Prepend given value to the head (enqueue to head). Unless backing array needs resizing, operates in O(1) time.
      Parameters:
      value - can be null
      See Also:

    • addFirst

      public void addFirst(boolean value1, boolean value2)

    • addFirst

      public void addFirst(boolean value1, boolean value2, boolean value3)

    • addFirst

      public void addFirst(boolean value1, boolean value2, boolean value3, boolean value4)

    • trimToSize

      public void trimToSize()
      Trims the capacity of this BooleanDeque instance to be the deque's current size. An application can use this operation to minimize the storage of a BooleanDeque instance.
      Overrides:
      trimToSize in class BooleanList

    • shrink

      public boolean[] shrink()
      Description copied from class: BooleanList
      Reduces the size of the backing array to the size of the actual items. This is useful to release memory when many items have been removed, or if it is known that more items will not be added.
      Overrides:
      shrink in class BooleanList
      Returns:
      BooleanList.items; this will be a different reference if this resized

    • ensureCapacity

      public boolean[] ensureCapacity(int additional)
      Increases the size of the backing array to accommodate the specified number of additional items. Useful before adding many items to avoid multiple backing array resizes.
      Overrides:
      ensureCapacity in class BooleanList
      Returns:
      the backing array this will use after this call

    • resize

      public boolean[] resize(int newSize)
      Resizes the backing array. newSize should be greater than the current size; otherwise, newSize will be set to size and the resize to the same size will (for most purposes) be wasted effort. If this is not empty, this will rearrange the items internally to be linear and have the head at index 0, with the tail at size - 1. This always allocates a new internal backing array.
      Overrides:
      resize in class BooleanList
      Returns:
      the new backing array, as a direct reference

    • ensureGap

      protected int ensureGap(int index, int gapSize)
      Make sure there is a "gap" of exactly gapSize values starting at index. This can resize the backing array to achieve this goal. If possible, this will keep the same backing array and modify it in-place. The "gap" is not assigned null, and may contain old/duplicate references; calling code must overwrite the entire gap with additional values to ensure GC correctness.
      Parameters:
      index - the 0-based index in the iteration order where the gap will be present
      gapSize - the number of items that will need filling in the gap, and can be filled without issues.
      Returns:
      the position in the array where the gap will begin, which is unrelated to the index

    • addAll

      public boolean addAll(BooleanList list)
      Overrides:
      addAll in class BooleanList

    • addAll

      public boolean addAll(BooleanList list, int offset, int count)
      Overrides:
      addAll in class BooleanList

    • removeFirst

      public boolean removeFirst()
      Remove the first item from the deque. (dequeue from head) Always O(1).
      Returns:
      removed boolean
      Throws:
      NoSuchElementException - when the deque is empty

    • removeLast

      public boolean removeLast()
      Remove the last item from the deque. (dequeue from tail) Always O(1).
      Returns:
      removed boolean
      Throws:
      NoSuchElementException - when the deque is empty
      See Also:

    • offerFirst

      public boolean offerFirst(boolean t)
      Inserts the specified element at the front of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the addFirst(boolean) method, which can fail to insert an element only by throwing an exception.
      Parameters:
      t - the element to add
      Returns:
      true if the element was added to this deque, else false
      Throws:
      ClassCastException - if the class of the specified element prevents it from being added to this deque
      NullPointerException - if the specified element is null and this deque does not permit null elements
      IllegalArgumentException - if some property of the specified element prevents it from being added to this deque

    • offerLast

      public boolean offerLast(boolean t)
      Inserts the specified element at the end of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the addLast(boolean) method, which can fail to insert an element only by throwing an exception.
      Parameters:
      t - the element to add
      Returns:
      true if the element was added to this deque, else false
      Throws:
      ClassCastException - if the class of the specified element prevents it from being added to this deque
      NullPointerException - if the specified element is null and this deque does not permit null elements
      IllegalArgumentException - if some property of the specified element prevents it from being added to this deque

    • pollFirst

      public boolean pollFirst()
      Retrieves and removes the first element of this deque, or returns defaultValue if this deque is empty. The default value is usually null unless it has been changed with setDefaultValue(boolean).
      Returns:
      the head of this deque, or defaultValue if this deque is empty
      See Also:

    • pollLast

      public boolean pollLast()
      Retrieves and removes the last element of this deque, or returns defaultValue if this deque is empty. The default value is usually null unless it has been changed with setDefaultValue(boolean).
      Returns:
      the tail of this deque, or defaultValue if this deque is empty
      See Also:

    • getFirst

      public boolean getFirst()
      Retrieves, but does not remove, the first element of this deque.

      This method differs from peekFirst only in that it throws an exception if this deque is empty.

      Returns:
      the head of this deque
      Throws:
      NoSuchElementException - if this deque is empty

    • getLast

      public boolean getLast()
      Retrieves, but does not remove, the last element of this deque. This method differs from peekLast only in that it throws an exception if this deque is empty.
      Returns:
      the tail of this deque
      Throws:
      NoSuchElementException - if this deque is empty

    • peekFirst

      public boolean peekFirst()
      Retrieves, but does not remove, the first element of this deque, or returns defaultValue if this deque is empty.
      Returns:
      the head of this deque, or defaultValue if this deque is empty

    • peekLast

      public boolean peekLast()
      Retrieves, but does not remove, the last element of this deque, or returns defaultValue if this deque is empty.
      Returns:
      the tail of this deque, or defaultValue if this deque is empty

    • removeFirstOccurrence

      public boolean removeFirstOccurrence(boolean o)
      Removes the first occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the first element e such that o == e (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).
      Parameters:
      o - element to be removed from this deque, if present
      Returns:
      true if an element was removed as a result of this call

    • removeLastOccurrence

      public boolean removeLastOccurrence(boolean o)
      Removes the last occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the last element e such that o == e (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).
      Parameters:
      o - element to be removed from this deque, if present
      Returns:
      true if an element was removed as a result of this call

    • add

      public boolean add(boolean t)
      Inserts the specified element into the deque represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and throwing an IllegalStateException if no space is currently available. When using a capacity-restricted deque, it is generally preferable to use offer.

      This method is equivalent to addLast(boolean).

      Specified by:
      add in interface PrimitiveCollection.OfBoolean
      Overrides:
      add in class BooleanList
      Parameters:
      t - the element to add
      Returns:
      true (as specified by Collection.add(E))

    • add

      public void add(boolean value1, boolean value2)
      Overrides:
      add in class BooleanList

    • add

      public void add(boolean value1, boolean value2, boolean value3)
      Overrides:
      add in class BooleanList

    • add

      public void add(boolean value1, boolean value2, boolean value3, boolean value4)
      Overrides:
      add in class BooleanList

    • insert

      public void insert(int index, boolean item)
      Inserts the specified element into this deque at the specified index. Unlike offerFirst(boolean) and offerLast(boolean), this does not run in expected constant time unless the index is less than or equal to 0 (where it acts like offerFirst()) or greater than or equal to size() (where it acts like offerLast()).
      Overrides:
      insert in class BooleanList
      Parameters:
      index - the index in the deque's insertion order to insert the item
      item - a boolean item to insert; may be null

    • offer

      public boolean offer(boolean t)
      Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and false if no space is currently available. When using a capacity-restricted deque, this method is generally preferable to the add(boolean) method, which can fail to insert an element only by throwing an exception.

      This method is equivalent to offerLast(boolean).

      Parameters:
      t - the element to add
      Returns:
      true if the element was added to this deque, else false

    • remove

      public boolean remove()
      Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from poll() only in that it throws an exception if this deque is empty.

      This method is equivalent to removeFirst().

      Returns:
      the head of the queue represented by this deque
      Throws:
      NoSuchElementException - if this deque is empty

    • poll

      public boolean poll()
      Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns defaultValue if this deque is empty.

      This method is equivalent to pollFirst().

      Returns:
      the first element of this deque, or defaultValue if this deque is empty

    • element

      public boolean element()
      Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from peek only in that it throws an exception if this deque is empty.

      This method is equivalent to getFirst().

      Returns:
      the head of the queue represented by this deque
      Throws:
      NoSuchElementException - if this deque is empty

    • peek

      public boolean peek()
      Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque), or returns defaultValue if this deque is empty.

      This method is equivalent to peekFirst().

      Overrides:
      peek in class BooleanList
      Returns:
      the head of the queue represented by this deque, or defaultValue if this deque is empty

    • addAll

      public boolean addAll(PrimitiveCollection.OfBoolean c)
      Adds all the elements in the specified collection at the end of this deque, as if by calling addLast(boolean) on each one, in the order that they are returned by the collection's iterator.

      When using a capacity-restricted deque, it is generally preferable to call offer separately on each element.

      An exception encountered while trying to add an element may result in only some of the elements having been successfully added when the associated exception is thrown.

      Specified by:
      addAll in interface PrimitiveCollection.OfBoolean
      Parameters:
      c - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call

    • addAllLast

      public boolean addAllLast(PrimitiveCollection.OfBoolean c)
      An alias for addAll(OfBoolean), this adds every item in c to this in order at the end.
      Parameters:
      c - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call

    • addAllFirst

      public boolean addAllFirst(PrimitiveCollection.OfBoolean c)
      Adds every item in c to this in order at the start. The iteration order of c will be preserved for the added items.
      Parameters:
      c - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call

    • insertAll

      public boolean insertAll(int index, PrimitiveCollection.OfBoolean c)
      An alias for addAll(int, OfBoolean); inserts all elements in the specified collection into this list at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
      Parameters:
      index - index at which to insert the first element from the specified collection
      c - collection containing elements to be added to this list
      Returns:
      true if this list changed as a result of the call

    • addAll

      public boolean addAll(int index, PrimitiveCollection.OfBoolean c)

    • addAll

      public boolean addAll(boolean[] array)
      Exactly like addAll(OfBoolean), but takes an array instead of a PrimitiveCollection.OfBoolean.
      Specified by:
      addAll in interface PrimitiveCollection.OfBoolean
      Overrides:
      addAll in class BooleanList
      Parameters:
      array - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAll

      public boolean addAll(boolean[] array, int offset, int length)
      Like addAll(boolean[]), but only uses at most length items from array, starting at offset.
      Specified by:
      addAll in interface PrimitiveCollection.OfBoolean
      Overrides:
      addAll in class BooleanList
      Parameters:
      array - the elements to be inserted into this deque
      offset - the index of the first item in array to add
      length - how many items, at most, to add from array into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllLast

      public boolean addAllLast(boolean[] array)
      An alias for addAll(boolean[]).
      Parameters:
      array - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllLast

      public boolean addAllLast(boolean[] array, int offset, int length)
      An alias for addAll(boolean[], int, int).
      Parameters:
      array - the elements to be inserted into this deque
      offset - the index of the first item in array to add
      length - how many items, at most, to add from array into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllFirst

      public boolean addAllFirst(boolean[] array)
      Exactly like addAllFirst(OfBoolean), but takes an array instead of a PrimitiveCollection.OfBoolean.
      Parameters:
      array - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllFirst

      public boolean addAllFirst(boolean[] array, int offset, int length)
      Like addAllFirst(boolean[]), but only uses at most length items from array, starting at offset. The order of array will be preserved, starting at the head of the deque.
      Parameters:
      array - the elements to be inserted into this deque
      offset - the index of the first item in array to add
      length - how many items, at most, to add from array into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • insertAll

      public boolean insertAll(int index, boolean[] array)
      Alias for addAll(int, boolean[]).
      Parameters:
      index - the index in this deque's iteration order to place the first item in array
      array - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call

    • insertAll

      public boolean insertAll(int index, boolean[] array, int offset, int length)
      Alias for addAll(int, boolean[], int, int).
      Parameters:
      index - the index in this deque's iteration order to place the first item in array
      array - the elements to be inserted into this deque
      offset - the index of the first item in array to add
      length - how many items, at most, to add from array into this
      Returns:
      true if this deque changed as a result of the call

    • addAll

      public boolean addAll(int index, boolean[] array)
      Like addAll(int, OfBoolean), but takes an array instead of a PrimitiveCollection.OfBoolean and inserts it so the first item will be at the given index. The order of array will be preserved, starting at the given index in this deque.
      Parameters:
      index - the index in this deque's iteration order to place the first item in array
      array - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAll

      public boolean addAll(int index, boolean[] array, int offset, int length)
      Like addAll(int, OfBoolean), but takes an array instead of a PrimitiveCollection.OfBoolean, gets items starting at offset from that array, using length items, and inserts them so the item at the given offset will be at the given index. The order of array will be preserved, starting at the given index in this deque.
      Parameters:
      index - the index in this deque's iteration order to place the first item in array
      array - the elements to be inserted into this deque
      offset - the index of the first item in array to add
      length - how many items, at most, to add from array into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAll

      public boolean addAll(Ordered.OfBoolean ord)
      Exactly like addAll(OfBoolean), but takes an Ordered.OfBoolean instead of a PrimitiveCollection.OfBoolean.
      Parameters:
      ord - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAll

      public boolean addAll(Ordered.OfBoolean ord, int offset, int length)
      Like addAll(boolean[]), but only uses at most length items from ord, starting at offset.
      Overrides:
      addAll in class BooleanList
      Parameters:
      ord - the elements to be inserted into this deque
      offset - the index of the first item in ord to add
      length - how many items, at most, to add from ord into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAll

      public boolean addAll(int index, Ordered.OfBoolean ord)
      Like addAll(int, OfBoolean), but takes an ord instead of a PrimitiveCollection.OfBoolean and inserts it so the first item will be at the given index. The order of ord will be preserved, starting at the given index in this deque.
      Parameters:
      index - the index in this deque's iteration order to place the first item in ord
      ord - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAll

      public boolean addAll(int index, Ordered.OfBoolean ord, int offset, int length)
      Like addAll(int, OfBoolean), but takes an array instead of a PrimitiveCollection.OfBoolean, gets items starting at offset from that array, using length items, and inserts them so the item at the given offset will be at the given index. The order of array will be preserved, starting at the given index in this deque.
      Overrides:
      addAll in class BooleanList
      Parameters:
      index - the index in this deque's iteration order to place the first item in array
      ord - the elements to be inserted into this deque
      offset - the index of the first item in array to add
      length - how many items, at most, to add from array into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllLast

      public boolean addAllLast(Ordered.OfBoolean ord)
      An alias for addAll(Ordered.OfBoolean).
      Parameters:
      ord - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllLast

      public boolean addAllLast(Ordered.OfBoolean ord, int offset, int length)
      An alias for addAll(Ordered.OfBoolean, int, int).
      Parameters:
      ord - the elements to be inserted into this deque
      offset - the index of the first item in ord to add
      length - how many items, at most, to add from ord into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllFirst

      public boolean addAllFirst(Ordered.OfBoolean ord)
      Exactly like addAllFirst(OfBoolean), but takes an ord instead of a PrimitiveCollection.OfBoolean.
      Parameters:
      ord - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllFirst

      public boolean addAllFirst(Ordered.OfBoolean ord, int offset, int length)
      Like addAllFirst(Ordered.OfBoolean), but only uses at most length items from ord, starting at offset. The order of ord will be preserved, starting at the head of the deque.
      Parameters:
      ord - the elements to be inserted into this deque
      offset - the index of the first item in ord to add
      length - how many items, at most, to add from ord into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • insertAll

      public boolean insertAll(int index, Ordered.OfBoolean ord)
      Alias for addAll(int, Ordered.OfBoolean).
      Parameters:
      index - the index in this deque's iteration order to place the first item in ord
      ord - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call

    • insertAll

      public boolean insertAll(int index, Ordered.OfBoolean ord, int offset, int length)
      Alias for addAll(int, Ordered.OfBoolean, int, int).
      Parameters:
      index - the index in this deque's iteration order to place the first item in ord
      ord - the elements to be inserted into this deque
      offset - the index of the first item in ord to add
      length - how many items, at most, to add from ord into this
      Returns:
      true if this deque changed as a result of the call

    • push

      public void push(boolean t)
      Pushes an element onto the stack represented by this deque (in other words, at the head of this deque).

      This method is equivalent to addFirst(boolean).

      Parameters:
      t - the element to push

    • pop

      public boolean pop()
      Pops an element from the stack represented by this deque. In other words, removes and returns the first element of this deque.

      This method is equivalent to removeFirst().

      Overrides:
      pop in class BooleanList
      Returns:
      the element at the front of this deque (which is the top of the stack represented by this deque)
      Throws:
      NoSuchElementException - if this deque is empty

    • remove

      public boolean remove(boolean o)
      Removes the first occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the first element e such that o == e (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).

      This method is equivalent to removeFirstOccurrence(boolean).

      Specified by:
      remove in interface PrimitiveCollection.OfBoolean
      Overrides:
      remove in class BooleanList
      Parameters:
      o - element to be removed from this deque, if present
      Returns:
      true if an element was removed as a result of this call

    • contains

      public boolean contains(boolean o)
      Returns true if this deque contains the specified element. More formally, returns true if and only if this deque contains at least one element e such that o == e.
      Specified by:
      contains in interface PrimitiveCollection.OfBoolean
      Overrides:
      contains in class BooleanList
      Parameters:
      o - element whose presence in this deque is to be tested
      Returns:
      true if this deque contains the specified element

    • containsAll

      public boolean containsAll(BooleanList other)
      Description copied from class: BooleanList
      Returns true if this BooleanList contains, at least once, every item in other; otherwise returns false.
      Overrides:
      containsAll in class BooleanList
      Parameters:
      other - an BooleanList
      Returns:
      true if this contains every item in other, otherwise false

    • size

      public int size()
      Returns the number of elements in this deque.
      Specified by:
      size in interface Arrangeable
      Specified by:
      size in interface PrimitiveCollection<Boolean>
      Overrides:
      size in class BooleanList
      Returns:
      the number of elements in this deque

    • toArray

      public boolean[] toArray()
      Returns an array containing all the elements in this collection. If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array's runtime component type is boolean.

      The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.

      Specified by:
      toArray in interface PrimitiveCollection.OfBoolean
      Overrides:
      toArray in class BooleanList
      Returns:
      an array, whose runtime component type is boolean, containing all the elements in this collection

    • toArray

      public boolean[] toArray(boolean[] array)
      Description copied from class: BooleanList
      If array.length at least equal to BooleanList.size(), this copies the contents of this into array and returns it; otherwise, it allocates a new boolean array that can fit all the items in this, and proceeds to copy into that and return that.
      Specified by:
      toArray in interface PrimitiveCollection.OfBoolean
      Overrides:
      toArray in class BooleanList
      Parameters:
      array - a boolean array that will be modified if it can fit BooleanList.size() items
      Returns:
      array, if it had sufficient size, or a new array otherwise, either with a copy of this

    • setSize

      public boolean[] setSize(int newSize)
      Description copied from class: BooleanList
      Sets the list size, leaving any values beyond the current size undefined.
      Overrides:
      setSize in class BooleanList
      Returns:
      BooleanList.items; this will be a different reference if this resized to a larger capacity

    • truncateLast

      public void truncateLast(int newSize)
      Alias for truncate(int).
      Parameters:
      newSize - the size this deque should have after this call completes, if smaller than the current size

    • truncate

      public void truncate(int newSize)
      Reduces the size of the deque to the specified size by bulk-removing items from the tail end. If the deque is already smaller than the specified size, no action is taken.
      Overrides:
      truncate in class BooleanList
      Parameters:
      newSize - the size this deque should have after this call completes, if smaller than the current size

    • truncateFirst

      public void truncateFirst(int newSize)
      Reduces the size of the deque to the specified size by bulk-removing from the head. If the deque is already smaller than the specified size, no action is taken.
      Parameters:
      newSize - the size this deque should have after this call completes, if smaller than the current size

    • removeRange

      public void removeRange(int fromIndex, int toIndex)
      Removes from this list all the elements whose index is between fromIndex, inclusive, and toIndex, exclusive. Shifts any succeeding elements to the left (reduces their index). This call shrinks the list by (toIndex - fromIndex) elements. If toIndex==fromIndex, this operation has no effect. If fromIndex is 0 or less, this delegates to truncateFirst(int); if toIndex is equal to or greater than the size of this collection, this delegates to truncate(int).
      This is public here, not protected as in most JDK collections, because there are actually sometimes needs for this in user code.
      Specified by:
      removeRange in interface Ordered.OfBoolean
      Overrides:
      removeRange in class BooleanList
      Parameters:
      fromIndex - index of first element to be removed (inclusive)
      toIndex - index after last element to be removed (exclusive)

    • indexOf

      public int indexOf(boolean value)
      Returns the index of the first occurrence of value in the deque, or -1 if no such value exists.
      Overrides:
      indexOf in class BooleanList
      Parameters:
      value - the boolean to look for
      Returns:
      An index of the first occurrence of value in the deque or -1 if no such value exists

    • indexOf

      public int indexOf(boolean value, int fromIndex)
      Returns the index of the first occurrence of value in the deque, or -1 if no such value exists. This returns fromIndex if value is present at that point, so if you chain calls to indexOf(), the subsequent fromIndex should be larger than the last-returned index.
      Parameters:
      value - the boolean to look for
      fromIndex - the initial index to check (zero-indexed, starts at the head, inclusive)
      Returns:
      An index of first occurrence of value at or after fromIndex in the deque, or -1 if no such value exists

    • lastIndexOf

      public int lastIndexOf(boolean value)
      Returns the index of the last occurrence of value in the deque, or -1 if no such value exists.
      Overrides:
      lastIndexOf in class BooleanList
      Parameters:
      value - the boolean to look for
      Returns:
      An index of the last occurrence of value in the deque or -1 if no such value exists

    • lastIndexOf

      public int lastIndexOf(boolean value, int fromIndex)
      Returns the index of last occurrence of value in the deque, starting from fromIndex and going backwards, or -1 if no such value exists. This returns fromIndex if value is present at that point, so if you chain calls to indexOf(), the subsequent fromIndex should be smaller than the last-returned index.
      Parameters:
      value - the boolean to look for
      fromIndex - the initial index to check (zero-indexed, starts at the head, inclusive)
      Returns:
      An index of last occurrence of value at or before fromIndex in the deque, or -1 if no such value exists

    • listIterator

      public BooleanList.BooleanListIterator listIterator()

    • listIterator

      public BooleanList.BooleanListIterator listIterator(int index)
      Gets an iterator over this deque that starts at the given index.
      Parameters:
      index - the index to start iterating from in this deque
      Returns:
      a reused iterator starting at the given index

    • removeValue

      public boolean removeValue(boolean value)
      Removes the first instance of the specified value in the deque.
      Parameters:
      value - the boolean to remove
      Returns:
      true if value was found and removed, false otherwise

    • removeLastValue

      public boolean removeLastValue(boolean value)
      Removes the last instance of the specified value in the deque.
      Parameters:
      value - the boolean to remove
      Returns:
      true if value was found and removed, false otherwise

    • removeAt

      public boolean removeAt(int index)
      Removes the element at the specified position in this deque. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the deque.
      Overrides:
      removeAt in class BooleanList
      Parameters:
      index - the index of the element to be removed
      Returns:
      the element previously at the specified position

    • pollAt

      public boolean pollAt(int index)
      Removes the element at the specified position in this deque. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the deque, or the default value if this is empty. This will not throw an Exception in normal usage, even if index is negative (which makes this simply return pollFirst()) or greater than or equal to size() (which makes this return pollLast()).
      This is an alias for poll(int) for compatibility with primitive-backed lists and deques; poll(int) can refer to the method that removes an item by value, not by index, in those types.
      Parameters:
      index - the index of the element to be removed
      Returns:
      the element previously at the specified position

    • poll

      public boolean poll(int index)
      Removes the element at the specified position in this deque. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the deque, or the default value if this is empty. This will not throw an Exception in normal usage, even if index is negative (which makes this simply return pollFirst()) or greater than or equal to size() (which makes this return pollLast()).
      Parameters:
      index - the index of the element to be removed
      Returns:
      the element previously at the specified position

    • removeAll

      public boolean removeAll(PrimitiveCollection.OfBoolean c)
      Description copied from class: BooleanList
      Removes from this BooleanList all occurrences of any elements contained in the specified collection.
      Specified by:
      removeAll in interface PrimitiveCollection.OfBoolean
      Overrides:
      removeAll in class BooleanList
      Parameters:
      c - a primitive collection of int items to remove fully, such as another BooleanList or a BooleanDeque
      Returns:
      true if this list was modified.

    • removeEach

      public boolean removeEach(PrimitiveCollection.OfBoolean c)
      Description copied from class: BooleanList
      Removes from this BooleanList element-wise occurrences of elements contained in the specified collection. Note that if a value is present more than once in this BooleanList, only one of those occurrences will be removed for each occurrence of that value in c. If c has the same contents as this BooleanList or has additional items, then removing each of c will clear this.
      Specified by:
      removeEach in interface PrimitiveCollection.OfBoolean
      Overrides:
      removeEach in class BooleanList
      Parameters:
      c - a primitive collection of int items to remove one-by-one, such as another BooleanList or a BooleanDeque
      Returns:
      true if this list was modified.

    • retainAll

      public boolean retainAll(PrimitiveCollection.OfBoolean other)
      Description copied from class: BooleanList
      Removes all items from this BooleanList that are not present somewhere in other, any number of times.
      Specified by:
      retainAll in interface PrimitiveCollection.OfBoolean
      Overrides:
      retainAll in class BooleanList
      Parameters:
      other - a PrimitiveCollection.OfBoolean that contains the items that this should keep, whenever present
      Returns:
      true if this BooleanList changed as a result of this call, otherwise false

    • notEmpty

      public boolean notEmpty()
      Returns true if the deque has one or more items.
      Specified by:
      notEmpty in interface PrimitiveCollection<Boolean>
      Overrides:
      notEmpty in class BooleanList
      Returns:
      true if the list has one or more items, or false otherwise

    • isEmpty

      public boolean isEmpty()
      Returns true if the deque is empty.
      Specified by:
      isEmpty in interface PrimitiveCollection<Boolean>
      Overrides:
      isEmpty in class BooleanList
      Returns:
      true if the list is empty, or false if it has any items

    • first

      public boolean first()
      Returns the first (head) item in the deque (without removing it).
      Specified by:
      first in interface PrimitiveCollection.OfBoolean
      Overrides:
      first in class BooleanList
      Returns:
      the first item, without modifying this
      Throws:
      NoSuchElementException - when the deque is empty
      See Also:

    • last

      public boolean last()
      Returns the last (tail) item in the deque (without removing it).
      Throws:
      NoSuchElementException - when the deque is empty
      See Also:

    • get

      public boolean get(int index)
      Returns the element at the specified position in this deque. Like ArrayList or BooleanList, but unlike LinkedList, this runs in O(1) time. It is expected to be slightly slower than BooleanList.get(int), which also runs in O(1) time. Unlike get() in ArrayList or BooleanList, this considers negative indices to refer to the first item, and too-large indices to refer to the last item. That means it delegates to getFirst() or getLast() in those cases instead of throwing an IndexOutOfBoundsException, though it may throw a NoSuchElementException if the deque is empty and there is no item it can get.
      Overrides:
      get in class BooleanList
      Parameters:
      index - index of the element to return
      Returns:
      the element at the specified position in this deque
      Throws:
      NoSuchElementException - if the deque is empty

    • peekAt

      public boolean peekAt(int index)
      Returns the element at the specified position in this deque. Like ArrayList or BooleanList, but unlike LinkedList, this runs in O(1) time. It is expected to be slightly slower than BooleanList.get(int), which also runs in O(1) time. Unlike get() in ArrayList or BooleanList, this considers negative indices to refer to the first item, and too-large indices to refer to the last item. That means it delegates to peekFirst() or peekLast() in those cases instead of throwing an IndexOutOfBoundsException, and it will return the default value if the deque is empty. Unless changed, the default value is usually null.
      Parameters:
      index - index of the element to return
      Returns:
      the element at the specified position in this deque

    • assign

      public boolean assign(int index, boolean item)
      Replaces the element at the specified position in this list with the specified element. If this deque is empty or the index is larger than the largest index currently in this deque, this delegates to addLast(boolean) and returns the default value. If the index is negative, this delegates to addFirst(boolean) and returns the default value.
      Parameters:
      index - index of the element to replace
      item - element to be stored at the specified position
      Returns:
      the element previously at the specified position

    • set

      public void set(int index, boolean item)
      Replaces the element at the specified position in this list with the specified element. If this deque is empty or the index is larger than the largest index currently in this deque, this delegates to addLast(boolean) and returns the default value. If the index is negative, this delegates to addFirst(boolean) and returns the default value.
      Overrides:
      set in class BooleanList
      Parameters:
      index - index of the element to replace
      item - element to be stored at the specified position

    • and

      public void and(int index, boolean value)
      Overrides:
      and in class BooleanList

    • and

      public BooleanList and(boolean value)

    • or

      public void or(int index, boolean value)
      Overrides:
      or in class BooleanList

    • or

      public BooleanList or(boolean value)

    • xor

      public void xor(int index, boolean value)
      Overrides:
      xor in class BooleanList

    • xor

      public BooleanList xor(boolean value)

    • not

      public void not(int index)
      Overrides:
      not in class BooleanList

    • not

      public BooleanList not()

    • replaceAll

      public void replaceAll(com.github.tommyettinger.function.BooleanPredicate operator)
      Description copied from class: BooleanList
      Replaces each element of this list with the result of applying the given operator to that element.
      Overrides:
      replaceAll in class BooleanList
      Parameters:
      operator - a BooleanPredicate (a functional interface defined in funderby)

    • replaceFirst

      public boolean replaceFirst(boolean find, boolean replace)
      Replaces the first occurrence of find with replace. Returns true if it performed the replacement, or false if there was nothing to replace. This also returns false if find and replace are the same.
      Overrides:
      replaceFirst in class BooleanList
      Parameters:
      find - the item to search for
      replace - the item to replace find with, if possible
      Returns:
      true if this changed, or false otherwise

    • replaceAll

      public int replaceAll(boolean find, boolean replace)
      Replaces every occurrence of find with replace. Returns the number of changed items, which is 0 if nothing was found or in the case that find and replace are the same.
      Overrides:
      replaceAll in class BooleanList
      Parameters:
      find - the item to search for
      replace - the item to replace find with, if possible
      Returns:
      the number of replacements that occurred; 0 if nothing was found or replaced

    • duplicateRange

      public boolean duplicateRange(int index, int count)
      Inserts the specified number of items at the specified index. The new items will have values equal to the values at those indices before the insertion, and the previous values will be pushed to after the duplicated range.
      Overrides:
      duplicateRange in class BooleanList
      Parameters:
      index - the first index to duplicate
      count - how many items to duplicate

    • clear

      public void clear()
      Removes all values from this deque. This operates in O(1) time.
      Specified by:
      clear in interface PrimitiveCollection<Boolean>
      Overrides:
      clear in class BooleanList

    • iterator

      public BooleanList.BooleanListIterator iterator()
      Returns an iterator for the items in the deque. Remove is supported.
      Reuses one of two iterators for this deque. For nested or multithreaded iteration, use BooleanDequeIterator(BooleanDeque).
      Specified by:
      iterator in interface PrimitiveCollection<Boolean>
      Specified by:
      iterator in interface PrimitiveCollection.OfBoolean
      Overrides:
      iterator in class BooleanList
      Returns:
      a BooleanIterator; use its nextBoolean() method instead of next()

    • descendingIterator

      public BooleanList.BooleanListIterator descendingIterator()
      Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from last (tail) to first (head).
      Reuses one of two descending iterators for this deque. For nested or multithreaded iteration, use BooleanDequeIterator(BooleanDeque, boolean).
      Returns:
      an iterator over the elements in this deque in reverse sequence

    • descendingIterator

      public BooleanList.BooleanListIterator descendingIterator(int index)
      Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from index backwards to first (head).
      Reuses one of two descending iterators for this deque. For nested or multithreaded iteration, use BooleanDequeIterator(BooleanDeque, boolean).
      Parameters:
      index - the index to start iterating from in this deque
      Returns:
      an iterator over the elements in this deque in reverse sequence

    • toString

      public String toString()
      Delegates to PrimitiveCollection.OfBoolean.toString(String, boolean) with a delimiter of ", " and square brackets enabled.
      Overrides:
      toString in class BooleanList
      Returns:
      the square-bracketed String representation of this BooleanDeque, with items separated by ", "

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface PrimitiveCollection<Boolean>
      Overrides:
      hashCode in class BooleanList

    • equals

      public boolean equals(Object o)
      Using == between each item in order, compares for equality with other subtypes of BooleanList. If o is not a BooleanList (and is also not somehow reference-equivalent to this collection), this returns false. This uses the PrimitiveCollection.OfBoolean.iterator() of both this and o, so if either is in the middle of a concurrent iteration that modifies the collection, this may fail.
      Specified by:
      equals in interface PrimitiveCollection<Boolean>
      Overrides:
      equals in class BooleanList
      Parameters:
      o - object to be compared for equality with this collection
      Returns:
      true if this is equal to o, or false otherwise

    • swap

      public void swap(int first, int second)
      Switches the ordering of positions first and second, without changing any items beyond that.
      Specified by:
      swap in interface Arrangeable
      Specified by:
      swap in interface Ordered.OfBoolean
      Overrides:
      swap in class BooleanList
      Parameters:
      first - the first position, must not be negative and must be less than size()
      second - the second position, must not be negative and must be less than size()

    • reverse

      public void reverse()
      Reverses this BooleanDeque in-place.
      Specified by:
      reverse in interface Arrangeable
      Specified by:
      reverse in interface Ordered.OfBoolean
      Overrides:
      reverse in class BooleanList

    • shuffle

      public void shuffle(Random rng)
      Description copied from interface: Ordered.OfBoolean
      Pseudo-randomly shuffles the order of this Ordered in-place. You can seed rng, the random number generator, with an identical seed to reproduce a shuffle on two Ordered with the same Arrangeable.size().
      Specified by:
      shuffle in interface Arrangeable
      Specified by:
      shuffle in interface Ordered.OfBoolean
      Overrides:
      shuffle in class BooleanList
      Parameters:
      rng - any Random class, such as one from juniper

    • sort

      public void sort()
      Attempts to sort this deque in-place using its natural ordering, which sorts false before true. Uses BooleanComparators.sort(boolean[], int, int, BooleanComparator).
      Overrides:
      sort in class BooleanList

    • sort

      public void sort(int from, int to)
      Uses BooleanComparators.sort(boolean[], int, int, BooleanComparator) to sort a (clamped) subrange of this collection in ascending order (false, then true).
      Overrides:
      sort in class BooleanList
      Parameters:
      from - the index of the first element (inclusive) to be sorted
      to - the index of the last element (exclusive) to be sorted

    • sort

      public void sort(BooleanComparator comparator)
      Sorts this deque in-place using BooleanComparators.sort(boolean[], int, int, BooleanComparator). This should operate in O(n log(n)) time or less when the internals of the deque are continuous (the head is before the tail in the array). If the internals are not continuous, this takes an additional O(n) step (where n is less than the size of the deque) to rearrange the internals before sorting. You can pass null as the value for comparator, which will make this use the natural ordering for boolean (false before true).
      Specified by:
      sort in interface Ordered.OfBoolean
      Overrides:
      sort in class BooleanList
      Parameters:
      comparator - the Comparator to use for boolean items; may be null to use the natural order of boolean items when boolean implements Comparable of boolean

    • sort

      public void sort(int from, int to, BooleanComparator comparator)
      Sorts a (clamped) subrange of this deque in-place using BooleanComparators.sort(boolean[], int, int, BooleanComparator). This should operate in O(n log(n)) time or less when the internals of the deque are continuous (the head is before the tail in the array). If the internals are not continuous, this takes an additional O(n) step (where n is less than the size of the deque) to rearrange the internals before sorting. You can pass null as the value for comparator, which will make this use the natural ordering for boolean (false before true).
      Overrides:
      sort in class BooleanList
      Parameters:
      from - the index of the first element (inclusive) to be sorted
      to - the index of the last element (exclusive) to be sorted
      comparator - the Comparator to use for boolean items; may be null to use the natural order of boolean items when boolean implements Comparable of boolean

    • getRandom

      public boolean getRandom(Random random)
      Gets a randomly selected item from this BooleanDeque, using the given random number generator. Throws a NoSuchElementException if empty.
      Parameters:
      random - any Random or subclass of it, such as AlternateRandom.
      Returns:
      a randomly selected item from this deque

    • random

      public boolean random(Random random)
      Gets a randomly selected item from this BooleanDeque, using the given random number generator.
      Specified by:
      random in interface Ordered.OfBoolean
      Overrides:
      random in class BooleanList
      Parameters:
      random - any Random or subclass of it, such as AlternateRandom.
      Returns:
      a randomly selected item from this deque, or the default value if empty

    • with

      public static BooleanDeque with()
      Constructs an empty deque. This is usually less useful than just using the constructor, but can be handy in some code-generation scenarios when you don't know how many arguments you will have.
      Returns:
      a new deque containing nothing

    • with

      public static BooleanDeque with(boolean item)
      Creates a new BooleanDeque that holds only the given item, but can be resized.
      Parameters:
      item - one boolean item
      Returns:
      a new BooleanDeque that holds the given item

    • with

      public static BooleanDeque with(boolean item0, boolean item1)
      Creates a new BooleanDeque that holds only the given items, but can be resized.
      Parameters:
      item0 - a boolean item
      item1 - a boolean item
      Returns:
      a new BooleanDeque that holds the given items

    • with

      public static BooleanDeque with(boolean item0, boolean item1, boolean item2)
      Creates a new BooleanDeque that holds only the given items, but can be resized.
      Parameters:
      item0 - a boolean item
      item1 - a boolean item
      item2 - a boolean item
      Returns:
      a new BooleanDeque that holds the given items

    • with

      public static BooleanDeque with(boolean item0, boolean item1, boolean item2, boolean item3)
      Creates a new BooleanDeque that holds only the given items, but can be resized.
      Parameters:
      item0 - a boolean item
      item1 - a boolean item
      item2 - a boolean item
      item3 - a boolean item
      Returns:
      a new BooleanDeque that holds the given items

    • with

      public static BooleanDeque with(boolean item0, boolean item1, boolean item2, boolean item3, boolean item4)
      Creates a new BooleanDeque that holds only the given items, but can be resized.
      Parameters:
      item0 - a boolean item
      item1 - a boolean item
      item2 - a boolean item
      item3 - a boolean item
      item4 - a boolean item
      Returns:
      a new BooleanDeque that holds the given items

    • with

      public static BooleanDeque with(boolean item0, boolean item1, boolean item2, boolean item3, boolean item4, boolean item5)
      Creates a new BooleanDeque that holds only the given items, but can be resized.
      Parameters:
      item0 - a boolean item
      item1 - a boolean item
      item2 - a boolean item
      item3 - a boolean item
      item4 - a boolean item
      item5 - a boolean item
      Returns:
      a new BooleanDeque that holds the given items

    • with

      public static BooleanDeque with(boolean item0, boolean item1, boolean item2, boolean item3, boolean item4, boolean item5, boolean item6)
      Creates a new BooleanDeque that holds only the given items, but can be resized.
      Parameters:
      item0 - a boolean item
      item1 - a boolean item
      item2 - a boolean item
      item3 - a boolean item
      item4 - a boolean item
      item5 - a boolean item
      item6 - a boolean item
      Returns:
      a new BooleanDeque that holds the given items

    • with

      public static BooleanDeque with(boolean item0, boolean item1, boolean item2, boolean item3, boolean item4, boolean item5, boolean item6, boolean item7)
      Creates a new BooleanDeque that holds only the given items, but can be resized.
      Parameters:
      item0 - a boolean item
      item1 - a boolean item
      item2 - a boolean item
      item3 - a boolean item
      item4 - a boolean item
      item5 - a boolean item
      item6 - a boolean item
      item7 - a boolean item
      Returns:
      a new BooleanDeque that holds the given items

    • with

      public static BooleanDeque with(boolean... varargs)
      Creates a new BooleanDeque that will hold the items in the given array or varargs. This overload will only be used when a boolean array is supplied, or if varargs are used and there are 9 or more arguments.
      Parameters:
      varargs - either 0 or more boolean items, or an array of boolean
      Returns:
      a new BooleanDeque that holds the given boolean items

    • parse

      public static BooleanDeque parse(String str, String delimiter)
      Calls parse(String, String, boolean) with brackets set to false.
      Parameters:
      str - a String that will be parsed in full
      delimiter - the delimiter between items in str
      Returns:
      a new collection parsed from str

    • parse

      public static BooleanDeque parse(String str, String delimiter, boolean brackets)
      Creates a new collection and fills it by calling PrimitiveCollection.OfBoolean.addLegible(String, String, int, int) on either all of str (if brackets is false) or str without its first and last chars (if brackets is true). Each item is expected to be separated by delimiter.
      Parameters:
      str - a String that will be parsed in full (depending on brackets)
      delimiter - the delimiter between items in str
      brackets - if true, the first and last chars in str will be ignored
      Returns:
      a new collection parsed from str

    • parse

      public static BooleanDeque parse(String str, String delimiter, int offset, int length)
      Creates a new collection and fills it by calling PrimitiveCollection.OfBoolean.addLegible(String, String, int, int) with the given four parameters as-is.
      Parameters:
      str - a String that will have the given section parsed
      delimiter - the delimiter between items in str
      offset - the first position to parse in str, inclusive
      length - how many chars to parse, starting from offset
      Returns:
      a new collection parsed from str