org.conqat.lib.commons.collections

Class CaseInsensitiveStringSet

java.lang.Object

org.conqat.lib.commons.collections.CaseInsensitiveStringSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>, java.util.Collection<java.lang.String>, java.util.Set<java.lang.String>

public class CaseInsensitiveStringSet
extends java.lang.Object
implements java.util.Set<java.lang.String>

Special implementation of a Set of Strings, which allows storing strings in a case-insensitive manner. Two strings which only differ in case are handled as equal and can thus occur just once in the set (the first string added to the set is retained).

It also allows accessing the case-sensitive representation of a string that was stored utilizing the get(String) method. I.e. storing string "A" in the set and calling set.get("a") will return the original representation "A".

This class does not inherit from AbstractSet or AbstractCollection as most provided operations have higher performance directly using the hash map instead of the iterator implementations. Moreover, comparison in AbstractCollection is performed with equals and the CaseInsensitiveStringSet violates this contract as it requires comparison after normalization with getMappingKey(String).

Constructor Summary

Constructors

Constructor and Description
CaseInsensitiveStringSet() Constructor.
CaseInsensitiveStringSet(java.util.Collection<java.lang.String> strings) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	add(java.lang.String e)
boolean	addAll(java.util.Collection<? extends java.lang.String> c)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
java.lang.String	get(java.lang.String string) Returns the case-sensitive representation of the given string, as it was stored with the call to add(String) or null if the string is not stored in the Set.
boolean	isEmpty()
java.util.Iterator<java.lang.String>	iterator()
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	retainAll(java.util.Collection<?> c)
int	size()
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

CaseInsensitiveStringSet

public CaseInsensitiveStringSet()

Constructor.

CaseInsensitiveStringSet

public CaseInsensitiveStringSet(java.util.Collection<java.lang.String> strings)

Constructor.

Method Detail

get

public java.lang.String get(java.lang.String string)

Returns the case-sensitive representation of the given string, as it was stored with the call to add(String) or null if the string is not stored in the Set.

size

public int size()

Specified by:

size in interface java.util.Collection<java.lang.String>

Specified by:

size in interface java.util.Set<java.lang.String>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<java.lang.String>

Specified by:

isEmpty in interface java.util.Set<java.lang.String>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<java.lang.String>

Specified by:

contains in interface java.util.Set<java.lang.String>

iterator

public java.util.Iterator<java.lang.String> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>

Specified by:

iterator in interface java.util.Collection<java.lang.String>

Specified by:

iterator in interface java.util.Set<java.lang.String>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<java.lang.String>

Specified by:

toArray in interface java.util.Set<java.lang.String>

toArray

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

Specified by:

toArray in interface java.util.Collection<java.lang.String>

Specified by:

toArray in interface java.util.Set<java.lang.String>

add

public boolean add(java.lang.String e)

Specified by:

add in interface java.util.Collection<java.lang.String>

Specified by:

add in interface java.util.Set<java.lang.String>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<java.lang.String>

Specified by:

remove in interface java.util.Set<java.lang.String>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<java.lang.String>

Specified by:

containsAll in interface java.util.Set<java.lang.String>

addAll

public boolean addAll(java.util.Collection<? extends java.lang.String> c)

Specified by:

addAll in interface java.util.Collection<java.lang.String>

Specified by:

addAll in interface java.util.Set<java.lang.String>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<java.lang.String>

Specified by:

retainAll in interface java.util.Set<java.lang.String>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<java.lang.String>

Specified by:

removeAll in interface java.util.Set<java.lang.String>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<java.lang.String>

Specified by:

clear in interface java.util.Set<java.lang.String>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object