Package org.apache.rat.utils

Class ReportingSet<T>

java.lang.Object

org.apache.rat.utils.ReportingSet<T>

Type Parameters:

T - the type of object

All Implemented Interfaces:

Iterable<T>, Collection<T>, Set<T>, SortedSet<T>

public class ReportingSet<T>
extends Object
implements SortedSet<T>

A sorted set that reports insertion collisions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReportingSet.Options

Constructor Summary

Constructors

Constructor	Description
ReportingSet()	Constructor.
ReportingSet(SortedSet<T> delegate)	Constructs.

Method Summary

Modifier and Type	Method	Description
boolean	add(T e)
boolean	addAll(Collection<? extends T> c)
boolean	addAllIfNotPresent(Collection<? extends T> c)
boolean	addIfNotPresent(T e)	Adds the item if it is not present.
void	clear()
Comparator<? super T>	comparator()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
T	first()
void	forEach(Consumer<? super T> action)
int	hashCode()
ReportingSet<T>	headSet(T toElement)
boolean	isEmpty()
Iterator<T>	iterator()
T	last()
Stream<T>	parallelStream()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	removeIf(Predicate<? super T> filter)
boolean	retainAll(Collection<?> c)
ReportingSet<T>	setDuplicateOption(ReportingSet.Options state)	If set true attempts to duplicate will throw an IllegalArgumentException.
ReportingSet<T>	setLog(Log log)	Sets the log that the reporting set will log to.
ReportingSet<T>	setLogLevel(Log.Level level)	Sets the log level that the reporting set will log at.
ReportingSet<T>	setMsgFormat(Function<T,String> msgFmt)	Sets the function to generate the log message.
int	size()
Spliterator<T>	spliterator()
Stream<T>	stream()
ReportingSet<T>	subSet(T fromElement, T toElement)
ReportingSet<T>	tailSet(T fromElement)
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

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

Constructor Details

ReportingSet

public ReportingSet()

Constructor. Creates a TreeSet of type T.

ReportingSet

public ReportingSet(SortedSet<T> delegate)

Constructs.

Parameters:

delegate - the SortedSet to delegate to.

Method Details

setMsgFormat

public ReportingSet<T> setMsgFormat(Function<T,String> msgFmt)

Sets the function to generate the log message.

Parameters:

msgFmt - A function to return the string to be displayed when a collision occurs.

Returns:

This for chaining.

setDuplicateOption

public ReportingSet<T> setDuplicateOption(ReportingSet.Options state)

If set true attempts to duplicate will throw an IllegalArgumentException. The default state is false;.

Parameters:

state - the state to set.

Returns:

this for chaining.

setLog

public ReportingSet<T> setLog(Log log)

Sets the log that the reporting set will log to. if not set the DefaultLog is used.

Parameters:

log - the Log implementation to use.

Returns:

this for chaining.

setLogLevel

public ReportingSet<T> setLogLevel(Log.Level level)

Sets the log level that the reporting set will log at. if not set the default level is WARN.

Parameters:

level - the log level to use.

Returns:

this for chaining.

addIfNotPresent

public boolean addIfNotPresent(T e)

Adds the item if it is not present. Does not report collisions.

Parameters:

e - the item to add.

Returns:

true if the item was added, false otherwise.

add

public boolean add(T e)

Specified by:

add in interface Collection<T>

Specified by:

add in interface Set<T>

addAll

public boolean addAll(Collection<? extends T> c)

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface Set<T>

addAllIfNotPresent

public boolean addAllIfNotPresent(Collection<? extends T> c)

clear

public void clear()

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface Set<T>

comparator

public Comparator<? super T> comparator()

Specified by:

comparator in interface SortedSet<T>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface Set<T>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface Set<T>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface Set<T>

Overrides:

equals in class Object

first

public T first()

Specified by:

first in interface SortedSet<T>

forEach

public void forEach(Consumer<? super T> action)

Specified by:

forEach in interface Iterable<T>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface Set<T>

Overrides:

hashCode in class Object

headSet

public ReportingSet<T> headSet(T toElement)

Specified by:

headSet in interface SortedSet<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface Set<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Set<T>

last

public T last()

Specified by:

last in interface SortedSet<T>

parallelStream

public Stream<T> parallelStream()

Specified by:

parallelStream in interface Collection<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface Set<T>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface Set<T>

removeIf

public boolean removeIf(Predicate<? super T> filter)

Specified by:

removeIf in interface Collection<T>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface Set<T>

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in interface Set<T>

spliterator

public Spliterator<T> spliterator()

Specified by:

spliterator in interface Collection<T>

Specified by:

spliterator in interface Iterable<T>

Specified by:

spliterator in interface Set<T>

Specified by:

spliterator in interface SortedSet<T>

stream

public Stream<T> stream()

Specified by:

stream in interface Collection<T>

subSet

public ReportingSet<T> subSet(T fromElement,
 T toElement)

Specified by:

subSet in interface SortedSet<T>

tailSet

public ReportingSet<T> tailSet(T fromElement)

Specified by:

tailSet in interface SortedSet<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface Set<T>

toArray

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

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface Set<T>