Class Tags

java.lang.Object

aQute.bnd.service.tags.Tags

All Implemented Interfaces:

Iterable<String>, Collection<String>, Set<String>

public class Tags
extends Object
implements Set<String>

A set of tags. A tag is a string-token which can be attached to an entity for categorization and filtering. Typically these entities then implement the Tagged interface.

Field Summary

Fields

Modifier and Type	Field	Description
static final Tags	NO_TAGS

Method Summary

Modifier and Type	Method	Description
boolean	add(String s)
boolean	addAll(Collection<? extends String> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
int	hashCode()
boolean	includesAny(String... tags)
boolean	isEmpty()
Iterator<String>	iterator()
static Tags	of(String... name)
static Tags	parse(String csvTags, Tags defaultTags)	Parses a comma-separated string of tags into a Tags object.
static String	print(Tags tags)	Helper printing a csv-string of the tags for display purposes.
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toString()

Methods inherited from class Object

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

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface Set

spliterator

Field Details

NO_TAGS

public static final Tags NO_TAGS

Method Details

size

public int size()

Specified by:

size in interface Collection<String>

Specified by:

size in interface Set<String>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<String>

Specified by:

isEmpty in interface Set<String>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<String>

Specified by:

contains in interface Set<String>

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Collection<String>

Specified by:

iterator in interface Iterable<String>

Specified by:

iterator in interface Set<String>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<String>

Specified by:

toArray in interface Set<String>

toArray

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

Specified by:

toArray in interface Collection<String>

Specified by:

toArray in interface Set<String>

add

public boolean add(String s)

Specified by:

add in interface Collection<String>

Specified by:

add in interface Set<String>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<String>

Specified by:

remove in interface Set<String>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<String>

Specified by:

containsAll in interface Set<String>

addAll

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

Specified by:

addAll in interface Collection<String>

Specified by:

addAll in interface Set<String>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<String>

Specified by:

retainAll in interface Set<String>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<String>

Specified by:

removeAll in interface Set<String>

clear

public void clear()

Specified by:

clear in interface Collection<String>

Specified by:

clear in interface Set<String>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<String>

Specified by:

equals in interface Set<String>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<String>

Specified by:

hashCode in interface Set<String>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

includesAny

public boolean includesAny(String... tags)

Parameters:

tags - (globs)

Returns:

true if any of the given tags is included in the current set of tags, otherwise returns false. Also if the current set of tags is empty, also true is returned.

of

public static Tags of(String... name)

Parameters:

name -

Returns:

a Tags instance with the given tags.

parse

public static Tags parse(String csvTags,
 Tags defaultTags)

Parses a comma-separated string of tags into a Tags object.

Parameters:

csvTags -

defaultTags - a default used when csvTags is null or blank

Returns:

populated Tags or the passed defaultTags.

print

public static String print(Tags tags)

Helper printing a csv-string of the tags for display purposes. The Tagged.EMPTY_TAGS is treated specially.

Returns:

a comma separated string of tags. If tags contains just 1 tag which is Tagged.EMPTY_TAGS then "-" is returned. If there are more than 1 tags, then Tagged.EMPTY_TAGS is omitted.