Package org.anchoranalysis.bean.primitive

Class StringSet

Object

org.anchoranalysis.bean.AnchorBean<StringSet>

org.anchoranalysis.bean.primitive.StringSet

All Implemented Interfaces:

Iterable<String>, PrimitiveBeanCollection<String>

public class StringSet
extends AnchorBean<StringSet>
implements PrimitiveBeanCollection<String>

A bean defining a set of Strings.

The elements are stored internally in a consistent ordering, according to their natural comparator.

An example:

    <datasets config-class="org.anchoranalysis.bean.primitive.StringSet" config-factory="stringSet">
 	<item>first_dataset</item>
 	<item>second_dataset</item>
 	<item>some_other_dataset</item>
   </datasets>
 

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
StringSet()
StringSet(String... values)	Constructs with one or more values added to the list.
StringSet(Set<String> set)

Method Summary

Modifier and Type	Method	Description
void	add(String value)	Add an element to the collection.
protected boolean	canEqual(Object other)
boolean	contains(String value)	Whether the collection contains a particular element?
StringSet	duplicateBean()	Duplicate the bean.
boolean	equals(Object o)
int	hashCode()
boolean	isEmpty()	Whether the collection is empty or not.
Iterator<String>	iterator()
Set<String>	set()	The underlying set of values.
Stream<String>	stream()	Creates a stream of elements in the set.

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

StringSet

public StringSet(String... values)

Constructs with one or more values added to the list.

Parameters:

values - the values

StringSet

public StringSet()

StringSet

public StringSet(Set<String> set)

Method Details

add

public void add(String value)

Description copied from interface: PrimitiveBeanCollection

Add an element to the collection.

Specified by:

add in interface PrimitiveBeanCollection<String>

Parameters:

value - the element to add.

contains

public boolean contains(String value)

Description copied from interface: PrimitiveBeanCollection

Whether the collection contains a particular element?

Specified by:

contains in interface PrimitiveBeanCollection<String>

Parameters:

value - the element to search for

Returns:

true iff the collection contains the element.

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>

isEmpty

public boolean isEmpty()

Description copied from interface: PrimitiveBeanCollection

Whether the collection is empty or not.

Specified by:

isEmpty in interface PrimitiveBeanCollection<String>

Returns:

true iff the collection contains zero elements.

stream

public Stream<String> stream()

Creates a stream of elements in the set.

Returns:

a newly created stream.

duplicateBean

public StringSet duplicateBean()

Duplicate the bean.

NOTE: We need to specifically-implement it as the AnchorBean functionality won't work with this implementation, as it uses non-default initialization (using a config-factory)

Overrides:

duplicateBean in class AnchorBean<StringSet>

Returns:

the newly created bean

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

set

public Set<String> set()

The underlying set of values.