Top Description Constructors Methods
org.eclipse.collections.impl.stack.primitive

public abstract Class AbstractCharStack

extends Object
implements CharStack
Class Inheritance
All Implemented Interfaces
org.eclipse.collections.api.stack.primitive.CharStack, org.eclipse.collections.api.ordered.primitive.OrderedCharIterable, org.eclipse.collections.api.CharIterable, org.eclipse.collections.api.PrimitiveIterable
Known Direct Subclasses
org.eclipse.collections.impl.stack.immutable.primitive.ImmutableCharArrayStack, org.eclipse.collections.impl.stack.mutable.primitive.CharArrayStack
Imports
java.util.EmptyStackException, org.eclipse.collections.api.LazyCharIterable, .CharIterable, .RichIterable, org.eclipse.collections.api.bag.primitive.MutableCharBag, org.eclipse.collections.api.block.function.primitive.ObjectCharIntToObjectFunction, .ObjectCharToObjectFunction, org.eclipse.collections.api.block.predicate.primitive.CharPredicate, org.eclipse.collections.api.block.procedure.primitive.CharProcedure, .CharIntProcedure, org.eclipse.collections.api.iterator.CharIterator, org.eclipse.collections.api.list.primitive.CharList, .MutableCharList, org.eclipse.collections.api.set.primitive.MutableCharSet, org.eclipse.collections.api.stack.primitive.CharStack, org.eclipse.collections.impl.bag.mutable.primitive.CharHashBag, org.eclipse.collections.impl.iterator.UnmodifiableCharIterator, org.eclipse.collections.impl.lazy.primitive.LazyCharIterableAdapter, org.eclipse.collections.impl.list.mutable.primitive.CharArrayList, org.eclipse.collections.impl.set.mutable.primitive.CharHashSet

This file was automatically generated from template file abstractPrimitiveStack.stg.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
allSatisfy(CharPredicate predicate)

Implements org.eclipse.collections.api.CharIterable.allSatisfy.

Returns true if all of the elements in the CharIterable return true for the specified predicate, otherwise returns false.

public boolean
anySatisfy(CharPredicate predicate)

Implements org.eclipse.collections.api.CharIterable.anySatisfy.

Returns true if any of the elements in the CharIterable return true for the specified predicate, otherwise returns false.

public void
appendString(Appendable appendable)

Overrides default org.eclipse.collections.api.PrimitiveIterable.appendString.

Prints a string representation of this collection onto the given Appendable.

public void
appendString(Appendable appendable, String separator)

Overrides default org.eclipse.collections.api.PrimitiveIterable.appendString.

Prints a string representation of this collection onto the given Appendable.

public void
appendString(Appendable appendable, String start, String separator, String end)

Implements org.eclipse.collections.api.PrimitiveIterable.appendString.

Prints a string representation of this collection onto the given Appendable.

public LazyCharIterable
asLazy()

Implements org.eclipse.collections.api.CharIterable.asLazy.

Returns a LazyCharIterable adapter wrapping the source CharIterable.

public double
public CharIterator
charIterator()

Implements org.eclipse.collections.api.CharIterable.charIterator.

Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.

protected void
protected void
protected void
public RichIterable<CharIterable>
chunk(int size)

Overrides default org.eclipse.collections.api.CharIterable.chunk.

Partitions elements in fixed size chunks.

public boolean
contains(char value)

Implements org.eclipse.collections.api.CharIterable.contains.

Returns true if the value is contained in the CharIterable, and false if it is not.

public boolean
containsAll(char... source)

Overrides default org.eclipse.collections.api.CharIterable.containsAll.

Returns true if all of the values specified in the source array are contained in the CharIterable, and false if they are not.

public boolean
containsAll(CharIterable source)

Overrides default org.eclipse.collections.api.CharIterable.containsAll.

Returns true if all of the values specified in the source CharIterable are contained in the CharIterable, and false if they are not.

public int
count(CharPredicate predicate)

Implements org.eclipse.collections.api.CharIterable.count.

Returns a count of the number of elements in the CharIterable that return true for the specified predicate.

public char
public void
each(CharProcedure procedure)

Implements org.eclipse.collections.api.CharIterable.each.

A synonym for forEach.

public boolean
public void
protected abstract CharArrayList
public char
public int
public int
public <V> V
injectInto(V injectedValue, ObjectCharToObjectFunction<? super V, ? extends V> function)

Implements org.eclipse.collections.api.CharIterable.injectInto.

public <T> T
public String
makeString()

Overrides default org.eclipse.collections.api.PrimitiveIterable.makeString.

Returns a string representation of this collection by delegating to makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).

public String
makeString(String separator)

Overrides default org.eclipse.collections.api.PrimitiveIterable.makeString.

Returns a string representation of this collection by delegating to makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).

public String
makeString(String start, String separator, String end)

Overrides default org.eclipse.collections.api.PrimitiveIterable.makeString.

Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.

public char
public char
public double
public char
public char
public boolean
noneSatisfy(CharPredicate predicate)

Overrides default org.eclipse.collections.api.CharIterable.noneSatisfy.

Returns true if none of the elements in the CharIterable return true for the specified predicate, otherwise returns false.

public char
peek()

Implements org.eclipse.collections.api.stack.primitive.CharStack.peek.

Returns the top of the stack.

public CharList
peek(int count)

Implements org.eclipse.collections.api.stack.primitive.CharStack.peek.

Returns CharList of the number of elements specified by the count, beginning with the top of the stack.

public char
peekAt(int index)

Implements org.eclipse.collections.api.stack.primitive.CharStack.peekAt.

Returns the element at the specified index.

protected void
rangeCheck(int index)

public int
size()

Implements org.eclipse.collections.api.PrimitiveIterable.size.

Returns the number of items in this iterable.

public long
public char[]
toArray()

Implements org.eclipse.collections.api.CharIterable.toArray.

Converts the CharIterable to a primitive char array.

public char[]
toArray(char[] target)

Overrides default org.eclipse.collections.api.CharIterable.toArray.

Converts the CharIterable to a primitive char array.

public MutableCharBag
toBag()

Implements org.eclipse.collections.api.CharIterable.toBag.

Converts the CharIterable to a new MutableCharBag.

public MutableCharList
toList()

Implements org.eclipse.collections.api.CharIterable.toList.

Converts the CharIterable to a new MutableCharList.

public MutableCharSet
toSet()

Implements org.eclipse.collections.api.CharIterable.toSet.

Converts the CharIterable to a new MutableCharSet.

public char[]
public String
toString()

Overrides java.lang.Object.toString.

Implements org.eclipse.collections.api.PrimitiveIterable.toString.

Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Constructor Detail

AbstractCharStackback to summary
public AbstractCharStack()

Method Detail

allSatisfyback to summary
public boolean allSatisfy(CharPredicate predicate)

Implements org.eclipse.collections.api.CharIterable.allSatisfy.

Doc from org.eclipse.collections.api.CharIterable.allSatisfy.

Returns true if all of the elements in the CharIterable return true for the specified predicate, otherwise returns false.

Annotations
@Override
anySatisfyback to summary
public boolean anySatisfy(CharPredicate predicate)

Implements org.eclipse.collections.api.CharIterable.anySatisfy.

Doc from org.eclipse.collections.api.CharIterable.anySatisfy.

Returns true if any of the elements in the CharIterable return true for the specified predicate, otherwise returns false.

Annotations
@Override
appendStringback to summary
public void appendString(Appendable appendable)

Overrides default org.eclipse.collections.api.PrimitiveIterable.appendString.

Doc from org.eclipse.collections.api.PrimitiveIterable.appendString.

Prints a string representation of this collection onto the given Appendable. Prints the string returned by makeString().

Annotations
@Override
appendStringback to summary
public void appendString(Appendable appendable, String separator)

Overrides default org.eclipse.collections.api.PrimitiveIterable.appendString.

Doc from org.eclipse.collections.api.PrimitiveIterable.appendString.

Prints a string representation of this collection onto the given Appendable. Prints the string returned by makeString(String).

Annotations
@Override
appendStringback to summary
public void appendString(Appendable appendable, String start, String separator, String end)

Implements org.eclipse.collections.api.PrimitiveIterable.appendString.

Doc from org.eclipse.collections.api.PrimitiveIterable.appendString.

Prints a string representation of this collection onto the given Appendable. Prints the string returned by makeString(String, String, String).

Annotations
@Override
asLazyback to summary
public LazyCharIterable asLazy()

Implements org.eclipse.collections.api.CharIterable.asLazy.

Doc from org.eclipse.collections.api.CharIterable.asLazy.

Returns a LazyCharIterable adapter wrapping the source CharIterable.

Annotations
@Override
averageback to summary
public double average()

Implements org.eclipse.collections.api.CharIterable.average.

Annotations
@Override
charIteratorback to summary
public CharIterator charIterator()

Implements org.eclipse.collections.api.CharIterable.charIterator.

Doc from org.eclipse.collections.api.CharIterable.charIterator.

Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.

Annotations
@Override
checkEmptyStackback to summary
protected void checkEmptyStack()
checkPositiveValueForCountback to summary
protected void checkPositiveValueForCount(int count)
checkSizeLessThanCountback to summary
protected void checkSizeLessThanCount(int count)
chunkback to summary
public RichIterable<CharIterable> chunk(int size)

Overrides default org.eclipse.collections.api.CharIterable.chunk.

Doc from org.eclipse.collections.api.CharIterable.chunk.

Partitions elements in fixed size chunks.

Annotations
@Override
containsback to summary
public boolean contains(char value)

Implements org.eclipse.collections.api.CharIterable.contains.

Doc from org.eclipse.collections.api.CharIterable.contains.

Returns true if the value is contained in the CharIterable, and false if it is not.

Annotations
@Override
containsAllback to summary
public boolean containsAll(char... source)

Overrides default org.eclipse.collections.api.CharIterable.containsAll.

Doc from org.eclipse.collections.api.CharIterable.containsAll.

Returns true if all of the values specified in the source array are contained in the CharIterable, and false if they are not.

Annotations
@Override
containsAllback to summary
public boolean containsAll(CharIterable source)

Overrides default org.eclipse.collections.api.CharIterable.containsAll.

Doc from org.eclipse.collections.api.CharIterable.containsAll.

Returns true if all of the values specified in the source CharIterable are contained in the CharIterable, and false if they are not.

Annotations
@Override
countback to summary
public int count(CharPredicate predicate)

Implements org.eclipse.collections.api.CharIterable.count.

Doc from org.eclipse.collections.api.CharIterable.count.

Returns a count of the number of elements in the CharIterable that return true for the specified predicate.

Annotations
@Override
detectIfNoneback to summary
public char detectIfNone(CharPredicate predicate, char ifNone)

Implements org.eclipse.collections.api.CharIterable.detectIfNone.

Annotations
@Override
eachback to summary
public void each(CharProcedure procedure)

Implements org.eclipse.collections.api.CharIterable.each.

Doc from org.eclipse.collections.api.CharIterable.each.

A synonym for forEach.

Annotations
@Override
Since
7.0.
equalsback to summary
public boolean equals(Object otherStack)

Overrides java.lang.Object.equals.

Implements org.eclipse.collections.api.stack.primitive.CharStack.equals.

Doc from org.eclipse.collections.api.stack.primitive.CharStack.equals.

Follows the same general contract as StackIterable#equals(Object).

Annotations
@Override
forEachWithIndexback to summary
public void forEachWithIndex(CharIntProcedure procedure)

Implements org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.forEachWithIndex.

Annotations
@Override
getDelegateback to summary
protected abstract CharArrayList getDelegate()
getFirstback to summary
public char getFirst()

Implements org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.getFirst.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Implements org.eclipse.collections.api.stack.primitive.CharStack.hashCode.

Doc from org.eclipse.collections.api.stack.primitive.CharStack.hashCode.

Follows the same general contract as StackIterable#hashCode().

Annotations
@Override
indexOfback to summary
public int indexOf(char value)

Implements org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.indexOf.

Annotations
@Override
injectIntoback to summary
public <V> V injectInto(V injectedValue, ObjectCharToObjectFunction<? super V, ? extends V> function)

Implements org.eclipse.collections.api.CharIterable.injectInto.

Annotations
@Override
injectIntoWithIndexback to summary
public <T> T injectIntoWithIndex(T injectedValue, ObjectCharIntToObjectFunction<? super T, ? extends T> function)

Implements org.eclipse.collections.api.ordered.primitive.OrderedCharIterable.injectIntoWithIndex.

Annotations
@Override
makeStringback to summary
public String makeString()

Overrides default org.eclipse.collections.api.PrimitiveIterable.makeString.

Doc from org.eclipse.collections.api.PrimitiveIterable.makeString.

Returns a string representation of this collection by delegating to makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).

Annotations
@Override
makeStringback to summary
public String makeString(String separator)

Overrides default org.eclipse.collections.api.PrimitiveIterable.makeString.

Doc from org.eclipse.collections.api.PrimitiveIterable.makeString.

Returns a string representation of this collection by delegating to makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).

Annotations
@Override
makeStringback to summary
public String makeString(String start, String separator, String end)

Overrides default org.eclipse.collections.api.PrimitiveIterable.makeString.

Doc from org.eclipse.collections.api.PrimitiveIterable.makeString.

Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.

Annotations
@Override
maxback to summary
public char max()

Implements org.eclipse.collections.api.CharIterable.max.

Annotations
@Override
maxIfEmptyback to summary
public char maxIfEmpty(char defaultValue)

Implements org.eclipse.collections.api.CharIterable.maxIfEmpty.

Annotations
@Override
medianback to summary
public double median()

Implements org.eclipse.collections.api.CharIterable.median.

Annotations
@Override
minback to summary
public char min()

Implements org.eclipse.collections.api.CharIterable.min.

Annotations
@Override
minIfEmptyback to summary
public char minIfEmpty(char defaultValue)

Implements org.eclipse.collections.api.CharIterable.minIfEmpty.

Annotations
@Override
noneSatisfyback to summary
public boolean noneSatisfy(CharPredicate predicate)

Overrides default org.eclipse.collections.api.CharIterable.noneSatisfy.

Doc from org.eclipse.collections.api.CharIterable.noneSatisfy.

Returns true if none of the elements in the CharIterable return true for the specified predicate, otherwise returns false.

Annotations
@Override
peekback to summary
public char peek()

Implements org.eclipse.collections.api.stack.primitive.CharStack.peek.

Doc from org.eclipse.collections.api.stack.primitive.CharStack.peek.

Returns the top of the stack.

Annotations
@Override
peekback to summary
public CharList peek(int count)

Implements org.eclipse.collections.api.stack.primitive.CharStack.peek.

Doc from org.eclipse.collections.api.stack.primitive.CharStack.peek.

Returns CharList of the number of elements specified by the count, beginning with the top of the stack.

Annotations
@Override
peekAtback to summary
public char peekAt(int index)

Implements org.eclipse.collections.api.stack.primitive.CharStack.peekAt.

Doc from org.eclipse.collections.api.stack.primitive.CharStack.peekAt.

Returns the element at the specified index.

Annotations
@Override
rangeCheckback to summary
protected void rangeCheck(int index)
sizeback to summary
public int size()

Implements org.eclipse.collections.api.PrimitiveIterable.size.

Doc from org.eclipse.collections.api.PrimitiveIterable.size.

Returns the number of items in this iterable.

Annotations
@Override
sumback to summary
public long sum()

Implements org.eclipse.collections.api.CharIterable.sum.

Annotations
@Override
toArrayback to summary
public char[] toArray()

Implements org.eclipse.collections.api.CharIterable.toArray.

Doc from org.eclipse.collections.api.CharIterable.toArray.

Converts the CharIterable to a primitive char array.

Annotations
@Override
toArrayback to summary
public char[] toArray(char[] target)

Overrides default org.eclipse.collections.api.CharIterable.toArray.

Doc from org.eclipse.collections.api.CharIterable.toArray.

Converts the CharIterable to a primitive char array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.

Annotations
@Override
toBagback to summary
public MutableCharBag toBag()

Implements org.eclipse.collections.api.CharIterable.toBag.

Doc from org.eclipse.collections.api.CharIterable.toBag.

Converts the CharIterable to a new MutableCharBag.

Annotations
@Override
toListback to summary
public MutableCharList toList()

Implements org.eclipse.collections.api.CharIterable.toList.

Doc from org.eclipse.collections.api.CharIterable.toList.

Converts the CharIterable to a new MutableCharList.

Annotations
@Override
toSetback to summary
public MutableCharSet toSet()

Implements org.eclipse.collections.api.CharIterable.toSet.

Doc from org.eclipse.collections.api.CharIterable.toSet.

Converts the CharIterable to a new MutableCharSet.

Annotations
@Override
toSortedArrayback to summary
public char[] toSortedArray()

Implements org.eclipse.collections.api.CharIterable.toSortedArray.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Implements org.eclipse.collections.api.PrimitiveIterable.toString.

Doc from org.eclipse.collections.api.PrimitiveIterable.toString.

Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.

Assert.assertEquals("[]", IntLists.mutable.empty().toString());
Assert.assertEquals("[1]", IntLists.mutable.with(1).toString());
Assert.assertEquals("[1, 2, 3]", IntLists.mutable.with(1, 2, 3).toString());
Annotations
@Override