ifs.fnd.log

Class Tags

java.lang.Object

ifs.fnd.log.Tags

public final class Tags
extends java.lang.Object

A class representing a single tag or a collection of tags that can be used for tagging debug and log output. A tag is just a simple string identifier that can be associated to any object. A tag can be typed or untyped. A tag type is a string identifier that can be used for grouping and filtering tags. Tag collection doesn't allow duplicated tag names, but two tags with the same name and different types are treated as different.

Constructor Summary

Constructors

Constructor and Description
Tags(java.lang.String name) Creates a new single tag recognized by the given name.
Tags(java.lang.String name, java.lang.String type) Creates a new single tag recognized by the given name and optional tag type.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String name) Adds a new single tag recognized by the given name to this tag collection.
void	add(java.lang.String name, java.lang.String type) Adds a new single tag recognized by the given name and optional type to this tag collection.
void	add(Tags tags) Adds a collection of tags to this tag collection.
boolean	contains(java.lang.String name) Returns true if this tag set contains the specified element.
boolean	contains(java.lang.String name, java.lang.String type) Returns true if this tag set contains the specified element.
boolean	contains(Tags tags) Returns true if this tag set contains all of the elements of the specified tag set.
java.lang.String	getName() Returns name of single tag or a comma separated list of names of all tags in the collection.
int	getSize() Returns number of single tags in this tag collection.
boolean	remove(java.lang.String name) Removes a named tag from this tag collections, if present.
boolean	remove(java.lang.String name, java.lang.String type) Removes a named tag from this tag collections, if present, represented by its name and optional type.
boolean	remove(Tags tags) Removes all the tags, if present, denoted by the 'tags' argument from this tag collection.
java.lang.String	toString() String representation of this tag collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

Tags

public Tags(java.lang.String name)

Creates a new single tag recognized by the given name. The name must not be empty.

Parameters:

name -

Tags

public Tags(java.lang.String name,
            java.lang.String type)

Creates a new single tag recognized by the given name and optional tag type. The name must not be empty.

Parameters:

name -

type -

Method Detail

add

public void add(java.lang.String name)

Adds a new single tag recognized by the given name to this tag collection. The name must not be empty. Duplicated tags will be removed.

Parameters:

name -

add

public void add(java.lang.String name,
                java.lang.String type)

Adds a new single tag recognized by the given name and optional type to this tag collection. The name must not be empty. Duplicated tags will be removed.

Parameters:

name -

type -

add

public void add(Tags tags)

Adds a collection of tags to this tag collection. Duplicated tags will be removed.

Parameters:

tags -

remove

public boolean remove(java.lang.String name)
               throws java.lang.IllegalArgumentException

Removes a named tag from this tag collections, if present.

Parameters:

name -

Returns:

true if this collection contained the specified tag

Throws:

java.lang.IllegalArgumentException - if the result would be an empty collection

remove

public boolean remove(java.lang.String name,
                      java.lang.String type)
               throws java.lang.IllegalArgumentException

Removes a named tag from this tag collections, if present, represented by its name and optional type.

Parameters:

name -

type -

Returns:

true if this collection contained the specified tag

Throws:

java.lang.IllegalArgumentException - if the result would be an empty collection

remove

public boolean remove(Tags tags)
               throws java.lang.IllegalArgumentException

Removes all the tags, if present, denoted by the 'tags' argument from this tag collection.

Parameters:

tags -

Returns:

true if this collection contained at least one of the tags specified as argument

Throws:

java.lang.IllegalArgumentException - if the result would be an empty collection

getName

public java.lang.String getName()

Returns name of single tag or a comma separated list of names of all tags in the collection.

Returns:

toString

public java.lang.String toString()

String representation of this tag collection. Returns comma separated list of tag names and types.

Overrides:

toString in class java.lang.Object

Returns:

getSize

public int getSize()

Returns number of single tags in this tag collection.

Returns:

contains

public boolean contains(java.lang.String name)

Returns true if this tag set contains the specified element.

Parameters:

name -

Returns:

contains

public boolean contains(java.lang.String name,
                        java.lang.String type)

Returns true if this tag set contains the specified element.

Parameters:

name -

type -

Returns:

contains

public boolean contains(Tags tags)

Returns true if this tag set contains all of the elements of the specified tag set.

Parameters:

tags -

Returns: