Package com.hello2morrow.sonargraph.api

Enum Class Aggregator

java.lang.Object

java.lang.Enum<Aggregator>

com.hello2morrow.sonargraph.api.Aggregator

All Implemented Interfaces:

Serializable, Comparable<Aggregator>, Constable

public enum Aggregator
extends Enum<Aggregator>

Aggregation levels for dependency aggregators.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPONENT	Aggregate on component level.
ELEMENT	Aggregate to level of elements (lowest aggregation level).
FIELD	Aggregate to level of fields.
METHOD	Aggregate to level of methods.
MODULE	Aggregate to level of module.
MODULE_NAMESPACE	Aggregate on module scope logical namespaces.
NAMED_TYPE	Aggregate to level of named types (including nested types).
ROUTINE	Aggregate to level of methods and free functions.
SOURCE_FILE	Aggregate on source file level.
SYSTEM_NAMESPACE	Aggregate on system wide logical namespaces.
TOPLEVEL_TYPE	Aggregate to level of top level types.
TYPE	Aggregate to level of types (including anonymous classes in Java).

Method Summary

Modifier and Type	Method	Description
static Aggregator	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Aggregator[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ELEMENT

public static final Aggregator ELEMENT

Aggregate to level of elements (lowest aggregation level).

TYPE

public static final Aggregator TYPE

Aggregate to level of types (including anonymous classes in Java).

NAMED_TYPE

public static final Aggregator NAMED_TYPE

Aggregate to level of named types (including nested types).

TOPLEVEL_TYPE

public static final Aggregator TOPLEVEL_TYPE

Aggregate to level of top level types.

METHOD

public static final Aggregator METHOD

Aggregate to level of methods.

ROUTINE

public static final Aggregator ROUTINE

Aggregate to level of methods and free functions.

FIELD

public static final Aggregator FIELD

Aggregate to level of fields.

SYSTEM_NAMESPACE

public static final Aggregator SYSTEM_NAMESPACE

Aggregate on system wide logical namespaces.

MODULE_NAMESPACE

public static final Aggregator MODULE_NAMESPACE

Aggregate on module scope logical namespaces.

MODULE

public static final Aggregator MODULE

Aggregate to level of module.

SOURCE_FILE

public static final Aggregator SOURCE_FILE

Aggregate on source file level.

COMPONENT

public static final Aggregator COMPONENT

Aggregate on component level.

Method Details

values

public static Aggregator[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Aggregator valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null