com.hello2morrow.sonargraph.plugin.api

Enum Aggregator

java.lang.Object

java.lang.Enum<Aggregator>

com.hello2morrow.sonargraph.plugin.api.Aggregator

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Aggregator>

public enum Aggregator
extends java.lang.Enum<Aggregator>

Aggregation levels for dependency aggregators.

Enum Constant Summary

Enum Constants

Enum Constant and 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 functions (C/C++).
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 and Description
static Aggregator	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Aggregator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 functions (C/C++).

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 Detail

values

public static Aggregator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Aggregator c : Aggregator.values())
    System.out.println(c);

Returns:

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

valueOf

public static Aggregator valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null