org.codehaus.mojo.flatten

Enum FlattenDependencyMode

java.lang.Object

java.lang.Enum<FlattenDependencyMode>

org.codehaus.mojo.flatten.FlattenDependencyMode

All Implemented Interfaces:

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

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

This enum contains the predefined modes on how to flatten the dependencies.

Since:

1.2.0

Author:

Ray Tsang

Enum Constant Summary

Enum Constants

Enum Constant and Description
all Flatten both direct and transitive dependencies.
direct Flatten only the direct dependency versions.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

direct

public static final FlattenDependencyMode direct

Flatten only the direct dependency versions. This is the default mode and compatible with Flatten Plugin prior to 1.2.0.

all

public static final FlattenDependencyMode all

Flatten both direct and transitive dependencies. This will examine the full dependency tree, and pull up all transitive dependencies as a direct dependency, and setting their versions appropriately. This is recommended if you are releasing a library that uses dependency management to manage dependency versions.

Method Detail

values

public static FlattenDependencyMode[] 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 (FlattenDependencyMode c : FlattenDependencyMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static FlattenDependencyMode 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