jalse.tags

Class TagTypeSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<Tag>

jalse.tags.TagTypeSet

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Tag>, java.util.Collection<Tag>, java.util.Set<Tag>

public class TagTypeSet
extends java.util.AbstractSet<Tag>
implements java.io.Serializable

A tag set is a thread-safe Set implementation for Tag. A tag set will allow multiple tags of the same type as long as none of them are considered equal. It is possible to query and remove tags by type as well as by instance.

See Also:

Object.equals(Object), Object.hashCode(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
TagTypeSet() Creates a new instance of tag set.

Method Summary

Modifier and Type	Method and Description
boolean	add(Tag e)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsOfType(java.lang.Class<? extends Tag> type) Checks whether the tag set contains any tags of that type.
<T extends Tag> java.util.Set<T>	getOfType(java.lang.Class<T> type) Gets all of the tags matching the specified type.
boolean	isEmpty()
java.util.Iterator<Tag>	iterator()
boolean	remove(java.lang.Object o)
boolean	removeOfType(java.lang.Class<? extends Tag> type) Removes all tags of the specified type.
int	size()

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

addAll, containsAll, retainAll, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

TagTypeSet

public TagTypeSet()

Creates a new instance of tag set.

Method Detail

add

public boolean add(Tag e)

Specified by:

add in interface java.util.Collection<Tag>

Specified by:

add in interface java.util.Set<Tag>

Overrides:

add in class java.util.AbstractCollection<Tag>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<Tag>

Specified by:

clear in interface java.util.Set<Tag>

Overrides:

clear in class java.util.AbstractCollection<Tag>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<Tag>

Specified by:

contains in interface java.util.Set<Tag>

Overrides:

contains in class java.util.AbstractCollection<Tag>

containsOfType

public boolean containsOfType(java.lang.Class<? extends Tag> type)

Checks whether the tag set contains any tags of that type.

Parameters:

type - Type of tag.

Returns:

true if the set contains any tags of the specified type or false if it does not.

getOfType

public <T extends Tag> java.util.Set<T> getOfType(java.lang.Class<T> type)

Gets all of the tags matching the specified type.

Parameters:

type - Type of tag.

Returns:

All tags of that type or an empty set if none are found.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<Tag>

Specified by:

isEmpty in interface java.util.Set<Tag>

Overrides:

isEmpty in class java.util.AbstractCollection<Tag>

iterator

public java.util.Iterator<Tag> iterator()

Specified by:

iterator in interface java.lang.Iterable<Tag>

Specified by:

iterator in interface java.util.Collection<Tag>

Specified by:

iterator in interface java.util.Set<Tag>

Specified by:

iterator in class java.util.AbstractCollection<Tag>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<Tag>

Specified by:

remove in interface java.util.Set<Tag>

Overrides:

remove in class java.util.AbstractCollection<Tag>

removeOfType

public boolean removeOfType(java.lang.Class<? extends Tag> type)

Removes all tags of the specified type.

Parameters:

type - Type of tag.

Returns:

Whether any tags were removed.

size

public int size()

Specified by:

size in interface java.util.Collection<Tag>

Specified by:

size in interface java.util.Set<Tag>

Specified by:

size in class java.util.AbstractCollection<Tag>