Package org.gradle.api.artifacts.result
Enum ComponentSelectionCause
- java.lang.Object
-
- java.lang.Enum<ComponentSelectionCause>
-
- org.gradle.api.artifacts.result.ComponentSelectionCause
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<ComponentSelectionCause>
public enum ComponentSelectionCause extends java.lang.Enum<ComponentSelectionCause>
The possible component selection causes. There are a limited number of causes, but each of them can be provided with a custom description, viaComponentSelectionDescriptor.- Since:
- 4.6
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BY_ANCESTORThis component was selected because it was requested by a parent with a strict version.COMPOSITE_BUILDThis component was selected as a participant of a composite.CONFLICT_RESOLUTIONThis component was selected between several candidates during conflict resolution.CONSTRAINTThis component was selected because of a dependency constraintFORCEDThis component was selected because selection was forced on this version.REJECTIONThis component was selected because another version was rejected by a ruleREQUESTEDThis component was selected because it was requested directly.ROOTThis component was selected because it's the root component.SELECTED_BY_RULEThis component was selected by a rule.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetDefaultReason()static ComponentSelectionCausevalueOf(java.lang.String name)Returns the enum constant of this type with the specified name.static ComponentSelectionCause[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ROOT
public static final ComponentSelectionCause ROOT
This component was selected because it's the root component.
-
REQUESTED
public static final ComponentSelectionCause REQUESTED
This component was selected because it was requested directly.
-
SELECTED_BY_RULE
public static final ComponentSelectionCause SELECTED_BY_RULE
This component was selected by a rule.
-
FORCED
public static final ComponentSelectionCause FORCED
This component was selected because selection was forced on this version.
-
CONFLICT_RESOLUTION
public static final ComponentSelectionCause CONFLICT_RESOLUTION
This component was selected between several candidates during conflict resolution.
-
COMPOSITE_BUILD
public static final ComponentSelectionCause COMPOSITE_BUILD
This component was selected as a participant of a composite.
-
REJECTION
public static final ComponentSelectionCause REJECTION
This component was selected because another version was rejected by a rule
-
CONSTRAINT
public static final ComponentSelectionCause CONSTRAINT
This component was selected because of a dependency constraint
-
BY_ANCESTOR
public static final ComponentSelectionCause BY_ANCESTOR
This component was selected because it was requested by a parent with a strict version.- Since:
- 6.0
-
-
Method Detail
-
values
public static ComponentSelectionCause[] 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 (ComponentSelectionCause c : ComponentSelectionCause.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ComponentSelectionCause 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 namejava.lang.NullPointerException- if the argument is null
-
getDefaultReason
public java.lang.String getDefaultReason()
-
-