org.ametys.cms.tag

Class TagHelper

java.lang.Object

org.ametys.cms.tag.TagHelper

public final class TagHelper
extends Object

Helper class which provides useful methods to operate on Tag objects.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TagHelper()

Method Summary

Modifier and Type	Method and Description
private static Set<Tag>	_getAncestors(Tag tag, boolean includeCurrent, Set<Tag> accumulator)
private static Set<Tag>	_getDescendants(Tag tag, boolean includeCurrent, Set<Tag> accumulator)
static Set<String>	getAncestorNames(Tag tag, boolean includeCurrent) Retrieves all name of the ancestors of the current tag.
static Set<Tag>	getAncestors(Tag tag, boolean includeCurrent) Retrieves all ancestors of the current tag.
static Set<String>	getDescendantNames(Tag tag, boolean includeCurrent) Retrieves all name of the descendants (direct and non-direct children) of the current tag.
static Set<Tag>	getDescendants(Tag tag, boolean includeCurrent) Retrieves all descendants (direct and non-direct children) of the current tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

TagHelper

private TagHelper()

Method Detail

getDescendants

public static Set<Tag> getDescendants(Tag tag,
                                      boolean includeCurrent)

Retrieves all descendants (direct and non-direct children) of the current tag.

Parameters:

tag - the current tag

includeCurrent - true to include the current tag itself

Returns:

the set of descendant tags.

_getDescendants

private static Set<Tag> _getDescendants(Tag tag,
                                        boolean includeCurrent,
                                        Set<Tag> accumulator)

getDescendantNames

public static Set<String> getDescendantNames(Tag tag,
                                             boolean includeCurrent)

Retrieves all name of the descendants (direct and non-direct children) of the current tag.

Parameters:

tag - the current tag

includeCurrent - true to include the current tag itself

Returns:

the set of descendant tag names

getAncestors

public static Set<Tag> getAncestors(Tag tag,
                                    boolean includeCurrent)

Retrieves all ancestors of the current tag.

Parameters:

tag - the current tag

includeCurrent - true to include the current tag itself

Returns:

the set of ancestor tags.

_getAncestors

private static Set<Tag> _getAncestors(Tag tag,
                                      boolean includeCurrent,
                                      Set<Tag> accumulator)

getAncestorNames

public static Set<String> getAncestorNames(Tag tag,
                                           boolean includeCurrent)

Retrieves all name of the ancestors of the current tag.

Parameters:

tag - the current tag

includeCurrent - true to include the current tag itself

Returns:

the set of ancestor tag names