Package org.gradle.api.initialization.resolve

Enum RepositoriesMode

java.lang.Object

java.lang.Enum<RepositoriesMode>

org.gradle.api.initialization.resolve.RepositoriesMode

All Implemented Interfaces:

Serializable, Comparable<RepositoriesMode>

@Incubating
public enum RepositoriesMode
extends Enum<RepositoriesMode>

The repository mode configures how repositories are setup in the build.

Since:

6.8

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAIL_ON_PROJECT_REPOS	If this mode is set, any repository declared directly in a project, either directly or via a plugin, will trigger a build error.
PREFER_PROJECT	If this mode is set, any repository declared on a project will cause the project to use the repositories declared by the project, ignoring those declared in settings.
PREFER_SETTINGS	If this mode is set, any repository declared directly in a project, either directly or via a plugin, will be ignored.

Method Summary

Modifier and Type	Method	Description
static RepositoriesMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RepositoriesMode[]	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

PREFER_PROJECT

public static final RepositoriesMode PREFER_PROJECT

If this mode is set, any repository declared on a project will cause the project to use the repositories declared by the project, ignoring those declared in settings. This is the default behavior.

PREFER_SETTINGS

public static final RepositoriesMode PREFER_SETTINGS

If this mode is set, any repository declared directly in a project, either directly or via a plugin, will be ignored.

FAIL_ON_PROJECT_REPOS

public static final RepositoriesMode FAIL_ON_PROJECT_REPOS

If this mode is set, any repository declared directly in a project, either directly or via a plugin, will trigger a build error.

Method Detail

values

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

Returns:

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

valueOf

public static RepositoriesMode valueOf(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:

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

NullPointerException - if the argument is null