com.gs.collections.impl.bag.mutable.primitive

Class CharHashBag

java.lang.Object

com.gs.collections.impl.bag.mutable.primitive.CharHashBag

All Implemented Interfaces:

CharBag, MutableCharBag, CharIterable, MutableCharCollection, PrimitiveIterable, Externalizable, Serializable

@NotThreadSafe
public final class CharHashBag
extends Object
implements MutableCharBag, Externalizable

CharHashBag is similar to HashBag, and is memory-optimized for char primitives. This file was automatically generated from template file primitiveHashBag.stg.

Since:

3.0.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CharHashBag()
CharHashBag(CharHashBag bag)
CharHashBag(CharIterable iterable)
CharHashBag(int size)

Method Summary

Modifier and Type	Method and Description
boolean	add(char item)
boolean	addAll(char... source)
boolean	addAll(CharIterable source)
void	addOccurrences(char item, int occurrences)
boolean	allSatisfy(CharPredicate predicate)
boolean	anySatisfy(CharPredicate predicate)
void	appendString(Appendable appendable) Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String separator) Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String start, String separator, String end) Prints a string representation of this collection onto the given Appendable.
LazyCharIterable	asLazy()
MutableCharBag	asSynchronized()
MutableCharBag	asUnmodifiable()
double	average()
CharIterator	charIterator()
void	clear()
<V> MutableBag<V>	collect(CharToObjectFunction<? extends V> function)
boolean	contains(char value)
boolean	containsAll(char... source)
boolean	containsAll(CharIterable source)
int	count(CharPredicate predicate)
char	detectIfNone(CharPredicate predicate, char ifNone)
boolean	equals(Object otherBag) Follows the same general contract as Bag.equals(Object).
void	forEach(CharProcedure procedure)
void	forEachWithOccurrences(CharIntProcedure procedure) For each distinct item, with the number of occurrences, execute the specified procedure.
int	hashCode() Follows the same general contract as Bag.hashCode().
<T> T	injectInto(T injectedValue, ObjectCharToObjectFunction<? super T,? extends T> function)
boolean	isEmpty() Returns true if this iterable has zero items.
String	makeString() Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
String	makeString(String separator) Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
String	makeString(String start, String separator, String end) Returns a string representation of this collection.
char	max()
char	maxIfEmpty(char defaultValue)
double	median()
char	min()
char	minIfEmpty(char defaultValue)
static CharHashBag	newBag(CharBag source)
static CharHashBag	newBag(CharIterable source)
static CharHashBag	newBag(int size)
static CharHashBag	newBagWith(char... source)
boolean	noneSatisfy(CharPredicate predicate)
boolean	notEmpty() The English equivalent of !this.isEmpty()
int	occurrencesOf(char item) The occurrences of a distinct item in the bag.
void	readExternal(ObjectInput in)
CharHashBag	reject(CharPredicate predicate)
boolean	remove(char item)
boolean	removeAll(char... source)
boolean	removeAll(CharIterable source)
boolean	removeOccurrences(char item, int occurrences)
boolean	retainAll(char... source)
boolean	retainAll(CharIterable source)
CharHashBag	select(CharPredicate predicate)
int	size() Returns the number of items in this iterable.
int	sizeDistinct() The size of the Bag when counting only distinct elements.
long	sum()
char[]	toArray()
MutableCharBag	toBag()
ImmutableCharBag	toImmutable() Returns an immutable copy of this bag.
MutableCharList	toList()
MutableCharSet	toSet()
char[]	toSortedArray()
MutableCharList	toSortedList()
String	toString() Returns a string representation of this PrimitiveIterable.
CharHashBag	with(char element)
CharHashBag	with(char element1, char element2)
CharHashBag	with(char element1, char element2, char element3)
CharHashBag	withAll(CharIterable iterable)
CharHashBag	without(char element)
CharHashBag	withoutAll(CharIterable iterable)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CharHashBag

public CharHashBag()

CharHashBag

public CharHashBag(int size)

CharHashBag

public CharHashBag(CharIterable iterable)

CharHashBag

public CharHashBag(CharHashBag bag)

Method Detail

newBag

public static CharHashBag newBag(int size)

newBagWith

public static CharHashBag newBagWith(char... source)

newBag

public static CharHashBag newBag(CharIterable source)

newBag

public static CharHashBag newBag(CharBag source)

isEmpty

public boolean isEmpty()

Description copied from interface: PrimitiveIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface PrimitiveIterable

notEmpty

public boolean notEmpty()

Description copied from interface: PrimitiveIterable

The English equivalent of !this.isEmpty()

Specified by:

notEmpty in interface PrimitiveIterable

size

public int size()

Description copied from interface: PrimitiveIterable

Returns the number of items in this iterable.

Specified by:

size in interface PrimitiveIterable

sizeDistinct

public int sizeDistinct()

Description copied from interface: CharBag

The size of the Bag when counting only distinct elements.

Specified by:

sizeDistinct in interface CharBag

clear

public void clear()

Specified by:

clear in interface MutableCharCollection

with

public CharHashBag with(char element)

Specified by:

with in interface MutableCharBag

Specified by:

with in interface MutableCharCollection

with

public CharHashBag with(char element1,
                        char element2)

with

public CharHashBag with(char element1,
                        char element2,
                        char element3)

withAll

public CharHashBag withAll(CharIterable iterable)

Specified by:

withAll in interface MutableCharBag

Specified by:

withAll in interface MutableCharCollection

without

public CharHashBag without(char element)

Specified by:

without in interface MutableCharBag

Specified by:

without in interface MutableCharCollection

withoutAll

public CharHashBag withoutAll(CharIterable iterable)

Specified by:

withoutAll in interface MutableCharBag

Specified by:

withoutAll in interface MutableCharCollection

contains

public boolean contains(char value)

Specified by:

contains in interface CharIterable

containsAll

public boolean containsAll(char... source)

Specified by:

containsAll in interface CharIterable

containsAll

public boolean containsAll(CharIterable source)

Specified by:

containsAll in interface CharIterable

occurrencesOf

public int occurrencesOf(char item)

Description copied from interface: CharBag

The occurrences of a distinct item in the bag.

Specified by:

occurrencesOf in interface CharBag

forEachWithOccurrences

public void forEachWithOccurrences(CharIntProcedure procedure)

Description copied from interface: CharBag

For each distinct item, with the number of occurrences, execute the specified procedure.

Specified by:

forEachWithOccurrences in interface CharBag

add

public boolean add(char item)

Specified by:

add in interface MutableCharCollection

remove

public boolean remove(char item)

Specified by:

remove in interface MutableCharCollection

addAll

public boolean addAll(char... source)

Specified by:

addAll in interface MutableCharCollection

addAll

public boolean addAll(CharIterable source)

Specified by:

addAll in interface MutableCharCollection

removeAll

public boolean removeAll(char... source)

Specified by:

removeAll in interface MutableCharCollection

removeAll

public boolean removeAll(CharIterable source)

Specified by:

removeAll in interface MutableCharCollection

retainAll

public boolean retainAll(CharIterable source)

Specified by:

retainAll in interface MutableCharCollection

See Also:

Collection.retainAll(Collection)

retainAll

public boolean retainAll(char... source)

Specified by:

retainAll in interface MutableCharCollection

See Also:

Collection.retainAll(Collection)

addOccurrences

public void addOccurrences(char item,
                           int occurrences)

Specified by:

addOccurrences in interface MutableCharBag

removeOccurrences

public boolean removeOccurrences(char item,
                                 int occurrences)

Specified by:

removeOccurrences in interface MutableCharBag

forEach

public void forEach(CharProcedure procedure)

Specified by:

forEach in interface CharIterable

select

public CharHashBag select(CharPredicate predicate)

Specified by:

select in interface CharBag

Specified by:

select in interface MutableCharBag

Specified by:

select in interface CharIterable

Specified by:

select in interface MutableCharCollection

reject

public CharHashBag reject(CharPredicate predicate)

Specified by:

reject in interface CharBag

Specified by:

reject in interface MutableCharBag

Specified by:

reject in interface CharIterable

Specified by:

reject in interface MutableCharCollection

injectInto

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

Specified by:

injectInto in interface CharIterable

equals

public boolean equals(Object otherBag)

Description copied from interface: CharBag

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

Specified by:

equals in interface CharBag

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: CharBag

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

Specified by:

hashCode in interface CharBag

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from interface: PrimitiveIterable

Returns a string representation of this PrimitiveIterable. The string representation consists of a list of the PrimitiveIterable's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String#valueOf().

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class Object

Returns:

a string representation of this PrimitiveIterable

makeString

public String makeString()

Description copied from interface: PrimitiveIterable

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

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

public String makeString(String separator)

Description copied from interface: PrimitiveIterable

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

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

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

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in the start and end strings. Adjacent elements are separated by the separator string. Elements are converted to strings using the appropriate version of String.valueOf().

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

appendString

public void appendString(Appendable appendable)

Description copied from interface: PrimitiveIterable

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

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable,
                         String separator)

Description copied from interface: PrimitiveIterable

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

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable,
                         String start,
                         String separator,
                         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

count

public int count(CharPredicate predicate)

Specified by:

count in interface CharIterable

anySatisfy

public boolean anySatisfy(CharPredicate predicate)

Specified by:

anySatisfy in interface CharIterable

allSatisfy

public boolean allSatisfy(CharPredicate predicate)

Specified by:

allSatisfy in interface CharIterable

noneSatisfy

public boolean noneSatisfy(CharPredicate predicate)

Specified by:

noneSatisfy in interface CharIterable

detectIfNone

public char detectIfNone(CharPredicate predicate,
                         char ifNone)

Specified by:

detectIfNone in interface CharIterable

collect

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

Specified by:

collect in interface CharBag

Specified by:

collect in interface MutableCharBag

Specified by:

collect in interface CharIterable

Specified by:

collect in interface MutableCharCollection

max

public char max()

Specified by:

max in interface CharIterable

min

public char min()

Specified by:

min in interface CharIterable

sum

public long sum()

Specified by:

sum in interface CharIterable

minIfEmpty

public char minIfEmpty(char defaultValue)

Specified by:

minIfEmpty in interface CharIterable

maxIfEmpty

public char maxIfEmpty(char defaultValue)

Specified by:

maxIfEmpty in interface CharIterable

average

public double average()

Specified by:

average in interface CharIterable

median

public double median()

Specified by:

median in interface CharIterable

toArray

public char[] toArray()

Specified by:

toArray in interface CharIterable

toSortedArray

public char[] toSortedArray()

Specified by:

toSortedArray in interface CharIterable

toList

public MutableCharList toList()

Specified by:

toList in interface CharIterable

toSortedList

public MutableCharList toSortedList()

Specified by:

toSortedList in interface CharIterable

toSet

public MutableCharSet toSet()

Specified by:

toSet in interface CharIterable

toBag

public MutableCharBag toBag()

Specified by:

toBag in interface CharIterable

asLazy

public LazyCharIterable asLazy()

Specified by:

asLazy in interface CharIterable

asUnmodifiable

public MutableCharBag asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableCharBag

Specified by:

asUnmodifiable in interface MutableCharCollection

asSynchronized

public MutableCharBag asSynchronized()

Specified by:

asSynchronized in interface MutableCharBag

Specified by:

asSynchronized in interface MutableCharCollection

toImmutable

public ImmutableCharBag toImmutable()

Description copied from interface: MutableCharBag

Returns an immutable copy of this bag.

Specified by:

toImmutable in interface CharBag

Specified by:

toImmutable in interface MutableCharBag

Specified by:

toImmutable in interface MutableCharCollection

charIterator

public CharIterator charIterator()

Specified by:

charIterator in interface CharIterable

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException

Specified by:

readExternal in interface Externalizable

Throws:

IOException