com.github.misberner.apcommons.util

Class ElementUtils

java.lang.Object

com.github.misberner.apcommons.util.ElementUtils

public class ElementUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
ElementUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	checkElementKind(Element elem, ElementKind... acceptedKinds)
static <E extends Element> Map<String,List<E>>	elementsByName(Iterable<? extends E> elements) Retrieves a by-name mapping for all the elements contained in the argument.
static <E extends Element> Map<String,E>	elementsByUniqueName(Iterable<? extends E> elements) Retrieves a by-name mapping for all the elements contained in the argument.
static <E extends Element> List<E>	filterPackageVisible(Iterable<? extends E> elemList)
static <E extends Element> List<E>	filterPublic(Iterable<? extends E> elemList)
static <E extends Element> List<E>	filterVisible(Iterable<? extends E> elemList, Visibility minimumVisibility)
Visibility	getEffectiveVisibility(Element element)
static PackageElement	getPackage(Element elem) Retrieves the PackageElement for the package which (indirectly) encloses the specified element.
static String	getPackageName(Element elem) Retrieves the name of the package which (indirectly) encloses the specified element.

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementUtils

public ElementUtils()

Method Detail

getPackage

public static PackageElement getPackage(Element elem)

Retrieves the PackageElement for the package which (indirectly) encloses the specified element.

Parameters:

elem - the element

Returns:

the package which encloses the element

getPackageName

public static String getPackageName(Element elem)

Retrieves the name of the package which (indirectly) encloses the specified element.

Parameters:

elem - the element

Returns:

the package which encloses the element

elementsByName

public static <E extends Element> Map<String,List<E>> elementsByName(Iterable<? extends E> elements)

Retrieves a by-name mapping for all the elements contained in the argument.

Note: the values of the returned map are actually Lists, since multiple elements might have the same simple name (e.g., in case of overloaded methods).

Parameters:

elements - the elements

Returns:

a by-name multi-mapping for the specified elements

elementsByUniqueName

public static <E extends Element> Map<String,E> elementsByUniqueName(Iterable<? extends E> elements)
                                                          throws DuplicateNameException

Retrieves a by-name mapping for all the elements contained in the argument.

Note: unlike the above elementsByName(Iterable), the mapping does not contain multiple elements per name. However, elements contains multiple elements with the same simple name, a DuplicateNameException is thrown.

Parameters:

elements - the elements

Returns:

a by-name mapping for the specified elements

Throws:

DuplicateNameException - if at least two elements in elements have the same simple name.

checkElementKind

public static boolean checkElementKind(Element elem,
                       ElementKind... acceptedKinds)

filterVisible

public static <E extends Element> List<E> filterVisible(Iterable<? extends E> elemList,
                                        Visibility minimumVisibility)

filterPublic

public static <E extends Element> List<E> filterPublic(Iterable<? extends E> elemList)

filterPackageVisible

public static <E extends Element> List<E> filterPackageVisible(Iterable<? extends E> elemList)

getEffectiveVisibility

public Visibility getEffectiveVisibility(Element element)