Package org.eclipse.collections.impl.string.immutable

Class CharAdapter

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractCharIterable

org.eclipse.collections.impl.string.immutable.CharAdapter

All Implemented Interfaces:

java.io.Serializable, java.lang.CharSequence, CharIterable, ImmutableCharCollection, CharList, ImmutableCharList, OrderedCharIterable, ReversibleCharIterable, PrimitiveIterable

public class CharAdapter
extends AbstractCharIterable
implements java.lang.CharSequence, ImmutableCharList, java.io.Serializable

Provides a view into the char[] stored in a String as an ImmutableCharList. This is a cleaner more OO way of providing many of the iterable protocols available in StringIterate for char values.

Since:

7.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	CharAdapter.InternalCharIterator

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	adapted
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
CharAdapter(java.lang.String value)

Method Summary

Modifier and Type	Method	Description
static CharAdapter	adapt(java.lang.String value)
boolean	allSatisfy(CharPredicate predicate)	Returns true if all of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
boolean	anySatisfy(CharPredicate predicate)	Returns true if any of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
void	appendString(java.lang.Appendable appendable, java.lang.String start, java.lang.String separator, java.lang.String end)	Prints a string representation of this collection onto the given Appendable.
LazyCharIterable	asReversed()
int	binarySearch(char value)
char	charAt(int index)
CharIterator	charIterator()	Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.
RichIterable<CharIterable>	chunk(int size)	Partitions elements in fixed size chunks.
<V> ImmutableList<V>	collect(CharToObjectFunction<? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
CharAdapter	collectChar(CharToCharFunction function)
boolean	contains(char expected)	Returns true if the value is contained in the CharIterable, and false if it is not.
int	count(CharPredicate predicate)	Returns a count of the number of elements in the CharIterable that return true for the specified predicate.
char	detectIfNone(CharPredicate predicate, char ifNone)
CharAdapter	distinct()
long	dotProduct(CharList list)
void	each(CharProcedure procedure)	A synonym for forEach.
boolean	equals(java.lang.Object otherList)	Follows the same general contract as List.equals(Object).
void	forEachWithIndex(CharIntProcedure procedure)
static CharAdapter	from(char... chars)
static CharAdapter	from(CharIterable iterable)
char	get(int index)
java.lang.Character	getCharacter(int index)
char	getFirst()
char	getLast()
int	hashCode()	Follows the same general contract as List.hashCode().
int	indexOf(char value)
<T> T	injectInto(T injectedValue, ObjectCharToObjectFunction<? super T,? extends T> function)
<T> T	injectIntoWithIndex(T injectedValue, ObjectCharIntToObjectFunction<? super T,? extends T> function)
boolean	isEmpty()	Returns true if this iterable has zero items.
int	lastIndexOf(char value)
int	length()
char	max()
char	min()
CharAdapter	newWith(char element)
CharAdapter	newWithAll(CharIterable elements)
CharAdapter	newWithout(char element)
CharAdapter	newWithoutAll(CharIterable elements)
boolean	noneSatisfy(CharPredicate predicate)	Returns true if none of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
CharAdapter	reject(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
CharAdapter	select(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
int	size()	Returns the number of items in this iterable.
ImmutableCharList	subList(int fromIndex, int toIndex)
java.lang.String	subSequence(int start, int end)
long	sum()
char[]	toArray()	Converts the CharIterable to a primitive char array.
char[]	toArray(char[] target)	Converts the CharIterable to a primitive char array.
MutableCharBag	toBag()	Converts the CharIterable to a new MutableCharBag.
ImmutableCharList	toImmutable()	Returns an immutable copy of this list.
MutableCharList	toList()	Converts the CharIterable to a new MutableCharList.
CharAdapter	toReversed()
MutableCharSet	toSet()	Converts the CharIterable to a new MutableCharSet.
MutableCharStack	toStack()	Converts the collection to a CharStack.
java.lang.String	toString()	The value of toString must be strictly implemented as defined in CharSequence.
java.lang.StringBuilder	toStringBuilder()
<T> ImmutableList<CharObjectPair<T>>	zip(java.lang.Iterable<T> iterable)	Returns an ImmutableList formed from this ImmutableCharList and a ListIterable by combining corresponding elements in pairs.
ImmutableList<CharCharPair>	zipChar(CharIterable iterable)	Returns an ImmutableList formed from this ImmutableCharList and another CharList by combining corresponding elements in pairs.

Methods inherited from class org.eclipse.collections.impl.primitive.AbstractCharIterable

asLazy, average, maxIfEmpty, median, minIfEmpty, toSortedArray, toSortedList

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.collections.api.CharIterable

asLazy, average, averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAll, containsAll, containsAny, containsAny, containsNone, containsNone, flatCollect, forEach, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, maxIfEmpty, median, medianIfEmpty, minIfEmpty, reduce, reduceIfEmpty, reject, select, summaryStatistics, toSortedArray, toSortedList, toSortedList, toSortedListBy, toSortedListBy

Methods inherited from interface org.eclipse.collections.api.list.primitive.CharList

forEachInBoth

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Methods inherited from interface org.eclipse.collections.api.list.primitive.ImmutableCharList

collectWithIndex, rejectWithIndex, selectWithIndex, tap

Methods inherited from interface org.eclipse.collections.api.ordered.primitive.OrderedCharIterable

collectWithIndex, rejectWithIndex, selectWithIndex

Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable

appendString, appendString, makeString, makeString, makeString, notEmpty

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

adapted

private final java.lang.String adapted

Constructor Detail

CharAdapter

public CharAdapter(java.lang.String value)

Method Detail

adapt

public static CharAdapter adapt(java.lang.String value)

from

public static CharAdapter from(char... chars)

from

public static CharAdapter from(CharIterable iterable)

charAt

public char charAt(int index)

Specified by:

charAt in interface java.lang.CharSequence

length

public int length()

Specified by:

length in interface java.lang.CharSequence

isEmpty

public boolean isEmpty()

Description copied from interface: PrimitiveIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface PrimitiveIterable

subSequence

public java.lang.String subSequence(int start,
                                    int end)

Specified by:

subSequence in interface java.lang.CharSequence

toStringBuilder

public java.lang.StringBuilder toStringBuilder()

toString

public java.lang.String toString()

The value of toString must be strictly implemented as defined in CharSequence.

Specified by:

toString in interface java.lang.CharSequence

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class AbstractCharIterable

Returns:

a string representation of this PrimitiveIterable

See Also:

AbstractCollection.toString()

charIterator

public CharIterator charIterator()

Description copied from interface: CharIterable

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

Specified by:

charIterator in interface CharIterable

toArray

public char[] toArray()

Description copied from interface: CharIterable

Converts the CharIterable to a primitive char array.

Specified by:

toArray in interface CharIterable

toArray

public char[] toArray(char[] target)

Description copied from interface: CharIterable

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.

Specified by:

toArray in interface CharIterable

contains

public boolean contains(char expected)

Description copied from interface: CharIterable

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

Specified by:

contains in interface CharIterable

each

public void each(CharProcedure procedure)

Description copied from interface: CharIterable

A synonym for forEach.

Specified by:

each in interface CharIterable

distinct

public CharAdapter distinct()

Specified by:

distinct in interface CharList

Specified by:

distinct in interface ImmutableCharList

Specified by:

distinct in interface ReversibleCharIterable

newWith

public CharAdapter newWith(char element)

Specified by:

newWith in interface ImmutableCharCollection

Specified by:

newWith in interface ImmutableCharList

newWithout

public CharAdapter newWithout(char element)

Specified by:

newWithout in interface ImmutableCharCollection

Specified by:

newWithout in interface ImmutableCharList

newWithAll

public CharAdapter newWithAll(CharIterable elements)

Specified by:

newWithAll in interface ImmutableCharCollection

Specified by:

newWithAll in interface ImmutableCharList

newWithoutAll

public CharAdapter newWithoutAll(CharIterable elements)

Specified by:

newWithoutAll in interface ImmutableCharCollection

Specified by:

newWithoutAll in interface ImmutableCharList

toReversed

public CharAdapter toReversed()

Specified by:

toReversed in interface CharList

Specified by:

toReversed in interface ImmutableCharList

Specified by:

toReversed in interface ReversibleCharIterable

subList

public ImmutableCharList subList(int fromIndex,
                                 int toIndex)

Specified by:

subList in interface CharList

Specified by:

subList in interface ImmutableCharList

See Also:

List.subList(int fromIndex, int toIndex)

get

public char get(int index)

Specified by:

get in interface CharList

getCharacter

public java.lang.Character getCharacter(int index)

dotProduct

public long dotProduct(CharList list)

Specified by:

dotProduct in interface CharList

binarySearch

public int binarySearch(char value)

Specified by:

binarySearch in interface CharList

lastIndexOf

public int lastIndexOf(char value)

Specified by:

lastIndexOf in interface CharList

toImmutable

public ImmutableCharList toImmutable()

Description copied from interface: CharList

Returns an immutable copy of this list. If the list is immutable, it returns itself.

Specified by:

toImmutable in interface CharList

getLast

public char getLast()

Specified by:

getLast in interface ReversibleCharIterable

asReversed

public LazyCharIterable asReversed()

Specified by:

asReversed in interface ReversibleCharIterable

injectIntoWithIndex

public <T> T injectIntoWithIndex(T injectedValue,
                                 ObjectCharIntToObjectFunction<? super T,? extends T> function)

Specified by:

injectIntoWithIndex in interface OrderedCharIterable

Specified by:

injectIntoWithIndex in interface ReversibleCharIterable

getFirst

public char getFirst()

Specified by:

getFirst in interface OrderedCharIterable

indexOf

public int indexOf(char value)

Specified by:

indexOf in interface OrderedCharIterable

forEachWithIndex

public void forEachWithIndex(CharIntProcedure procedure)

Specified by:

forEachWithIndex in interface OrderedCharIterable

select

public CharAdapter select(CharPredicate predicate)

Description copied from interface: CharIterable

Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.

Specified by:

select in interface CharIterable

Specified by:

select in interface CharList

Specified by:

select in interface ImmutableCharCollection

Specified by:

select in interface ImmutableCharList

Specified by:

select in interface OrderedCharIterable

Specified by:

select in interface ReversibleCharIterable

reject

public CharAdapter reject(CharPredicate predicate)

Description copied from interface: CharIterable

Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.

Specified by:

reject in interface CharIterable

Specified by:

reject in interface CharList

Specified by:

reject in interface ImmutableCharCollection

Specified by:

reject in interface ImmutableCharList

Specified by:

reject in interface OrderedCharIterable

Specified by:

reject in interface ReversibleCharIterable

collect

public <V> ImmutableList<V> collect(CharToObjectFunction<? extends V> function)

Description copied from interface: CharIterable

Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Specified by:

collect in interface CharIterable

Specified by:

collect in interface CharList

Specified by:

collect in interface ImmutableCharCollection

Specified by:

collect in interface ImmutableCharList

Specified by:

collect in interface OrderedCharIterable

Specified by:

collect in interface ReversibleCharIterable

collectChar

public CharAdapter collectChar(CharToCharFunction function)

detectIfNone

public char detectIfNone(CharPredicate predicate,
                         char ifNone)

Specified by:

detectIfNone in interface CharIterable

count

public int count(CharPredicate predicate)

Description copied from interface: CharIterable

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

Specified by:

count in interface CharIterable

anySatisfy

public boolean anySatisfy(CharPredicate predicate)

Description copied from interface: CharIterable

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

Specified by:

anySatisfy in interface CharIterable

allSatisfy

public boolean allSatisfy(CharPredicate predicate)

Description copied from interface: CharIterable

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

Specified by:

allSatisfy in interface CharIterable

noneSatisfy

public boolean noneSatisfy(CharPredicate predicate)

Description copied from interface: CharIterable

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

Specified by:

noneSatisfy in interface CharIterable

toList

public MutableCharList toList()

Description copied from interface: CharIterable

Converts the CharIterable to a new MutableCharList.

Specified by:

toList in interface CharIterable

Overrides:

toList in class AbstractCharIterable

toSet

public MutableCharSet toSet()

Description copied from interface: CharIterable

Converts the CharIterable to a new MutableCharSet.

Specified by:

toSet in interface CharIterable

Overrides:

toSet in class AbstractCharIterable

toBag

public MutableCharBag toBag()

Description copied from interface: CharIterable

Converts the CharIterable to a new MutableCharBag.

Specified by:

toBag in interface CharIterable

Overrides:

toBag in class AbstractCharIterable

injectInto

public <T> T injectInto(T injectedValue,
                        ObjectCharToObjectFunction<? super T,? extends T> function)

Specified by:

injectInto in interface CharIterable

chunk

public RichIterable<CharIterable> chunk(int size)

Description copied from interface: CharIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface CharIterable

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing CharIterables of size size, except the last will be truncated if the elements don't divide evenly.

sum

public long sum()

Specified by:

sum in interface CharIterable

max

public char max()

Specified by:

max in interface CharIterable

min

public char min()

Specified by:

min in interface CharIterable

size

public int size()

Description copied from interface: PrimitiveIterable

Returns the number of items in this iterable.

Specified by:

size in interface PrimitiveIterable

appendString

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

Description copied from interface: PrimitiveIterable

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

Specified by:

appendString in interface PrimitiveIterable

equals

public boolean equals(java.lang.Object otherList)

Description copied from interface: CharList

Follows the same general contract as List.equals(Object).

Specified by:

equals in interface CharList

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Description copied from interface: CharList

Follows the same general contract as List.hashCode().

Specified by:

hashCode in interface CharList

Overrides:

hashCode in class java.lang.Object

zipChar

public ImmutableList<CharCharPair> zipChar(CharIterable iterable)

Description copied from interface: ImmutableCharList

Returns an ImmutableList formed from this ImmutableCharList and another CharList by combining corresponding elements in pairs. If one of the two CharLists is longer than the other, its remaining elements are ignored.

Specified by:

zipChar in interface CharList

Specified by:

zipChar in interface ImmutableCharList

Since:

9.1.

zip

public <T> ImmutableList<CharObjectPair<T>> zip(java.lang.Iterable<T> iterable)

Description copied from interface: ImmutableCharList

Returns an ImmutableList formed from this ImmutableCharList and a ListIterable by combining corresponding elements in pairs. If one of the two Lists is longer than the other, its remaining elements are ignored.

Specified by:

zip in interface CharList

Specified by:

zip in interface ImmutableCharList

Since:

9.1.

toStack

public MutableCharStack toStack()

Description copied from interface: OrderedCharIterable

Converts the collection to a CharStack.

Specified by:

toStack in interface OrderedCharIterable