Package org.gradle.api.plugins
Class JavaPlugin
- java.lang.Object
-
- org.gradle.api.plugins.JavaPlugin
-
-
Field Summary
Fields Modifier and Type Field Description static StringANNOTATION_PROCESSOR_CONFIGURATION_NAMEThe name of the annotation processor configuration.static StringAPI_CONFIGURATION_NAMEThe name of the API configuration, where dependencies exported by a component at compile time should be declared.static StringAPI_ELEMENTS_CONFIGURATION_NAMEThe name of the configuration used by consumers to get the API elements of a component, that is to say the dependencies which are required to compile against that component.static StringCLASSES_TASK_NAMEThe name of the lifecycle task which outcome is that all the classes of a component are generated.static StringCOMPILE_CLASSPATH_CONFIGURATION_NAMEThe name of the compile classpath configuration.static StringCOMPILE_CONFIGURATION_NAMEDeprecated.Users should preferAPI_CONFIGURATION_NAMEorIMPLEMENTATION_CONFIGURATION_NAME.static StringCOMPILE_JAVA_TASK_NAMEThe name of the task which compiles Java sources.static StringCOMPILE_ONLY_CONFIGURATION_NAMEThe name of the configuration that is used to declare dependencies which are only required to compile a component, but not at runtime.static StringCOMPILE_TEST_JAVA_TASK_NAMEThe name of the task which compiles the test Java sources.static StringIMPLEMENTATION_CONFIGURATION_NAMEThe name of the implementation configuration, where dependencies that are only used internally by a component should be declared.static StringJAR_TASK_NAMEThe name of the task which generates the component main jar.static StringJAVADOC_TASK_NAMEThe name of the task which generates the component javadoc.static StringPROCESS_RESOURCES_TASK_NAMEThe name of the task that processes resources.static StringPROCESS_TEST_RESOURCES_TASK_NAMEThe name of the task which processes the test resources.static StringRUNTIME_CLASSPATH_CONFIGURATION_NAMEThe name of the runtime classpath configuration, used by a component to query its own runtime classpath.static StringRUNTIME_CONFIGURATION_NAMEDeprecated.Consumers should useRUNTIME_ELEMENTS_CONFIGURATION_NAMEinstead.static StringRUNTIME_ELEMENTS_CONFIGURATION_NAMEThe name of the runtime elements configuration, that should be used by consumers to query the runtime dependencies of a component.static StringRUNTIME_ONLY_CONFIGURATION_NAMEThe name of the runtime only dependencies configuration, used to declare dependencies that should only be found at runtime.static StringTEST_ANNOTATION_PROCESSOR_CONFIGURATION_NAMEThe name of the test annotation processor configuration.static StringTEST_CLASSES_TASK_NAMEThe name of the lifecycle task which outcome is that all test classes of a component are generated.static StringTEST_COMPILE_CLASSPATH_CONFIGURATION_NAMEThe name of the test compile classpath configuration.static StringTEST_COMPILE_CONFIGURATION_NAMEstatic StringTEST_COMPILE_ONLY_CONFIGURATION_NAMEThe name of the configuration that should be used to declare dependencies which are only required to compile the tests, but not when running them.static StringTEST_IMPLEMENTATION_CONFIGURATION_NAMEThe name of the test implementation dependencies configuration.static StringTEST_RUNTIME_CLASSPATH_CONFIGURATION_NAMEThe name of the test runtime classpath configuration.static StringTEST_RUNTIME_CONFIGURATION_NAMEDeprecated.UseTEST_RUNTIME_CLASSPATH_CONFIGURATION_NAMEinstead.static StringTEST_RUNTIME_ONLY_CONFIGURATION_NAMEThe name of the test runtime only dependencies configuration.static StringTEST_TASK_NAMEThe name of the task which triggers execution of tests.
-
Constructor Summary
Constructors Constructor Description JavaPlugin(ObjectFactory objectFactory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidapply(org.gradle.api.internal.project.ProjectInternal project)Apply this plugin to the given target object.
-
-
-
Field Detail
-
PROCESS_RESOURCES_TASK_NAME
public static final String PROCESS_RESOURCES_TASK_NAME
The name of the task that processes resources.- See Also:
- Constant Field Values
-
CLASSES_TASK_NAME
public static final String CLASSES_TASK_NAME
The name of the lifecycle task which outcome is that all the classes of a component are generated.- See Also:
- Constant Field Values
-
COMPILE_JAVA_TASK_NAME
public static final String COMPILE_JAVA_TASK_NAME
The name of the task which compiles Java sources.- See Also:
- Constant Field Values
-
PROCESS_TEST_RESOURCES_TASK_NAME
public static final String PROCESS_TEST_RESOURCES_TASK_NAME
The name of the task which processes the test resources.- See Also:
- Constant Field Values
-
TEST_CLASSES_TASK_NAME
public static final String TEST_CLASSES_TASK_NAME
The name of the lifecycle task which outcome is that all test classes of a component are generated.- See Also:
- Constant Field Values
-
COMPILE_TEST_JAVA_TASK_NAME
public static final String COMPILE_TEST_JAVA_TASK_NAME
The name of the task which compiles the test Java sources.- See Also:
- Constant Field Values
-
TEST_TASK_NAME
public static final String TEST_TASK_NAME
The name of the task which triggers execution of tests.- See Also:
- Constant Field Values
-
JAR_TASK_NAME
public static final String JAR_TASK_NAME
The name of the task which generates the component main jar.- See Also:
- Constant Field Values
-
JAVADOC_TASK_NAME
public static final String JAVADOC_TASK_NAME
The name of the task which generates the component javadoc.- See Also:
- Constant Field Values
-
API_CONFIGURATION_NAME
public static final String API_CONFIGURATION_NAME
The name of the API configuration, where dependencies exported by a component at compile time should be declared.- Since:
- 3.4
- See Also:
- Constant Field Values
-
IMPLEMENTATION_CONFIGURATION_NAME
public static final String IMPLEMENTATION_CONFIGURATION_NAME
The name of the implementation configuration, where dependencies that are only used internally by a component should be declared.- Since:
- 3.4
- See Also:
- Constant Field Values
-
API_ELEMENTS_CONFIGURATION_NAME
public static final String API_ELEMENTS_CONFIGURATION_NAME
The name of the configuration used by consumers to get the API elements of a component, that is to say the dependencies which are required to compile against that component.- Since:
- 3.4
- See Also:
- Constant Field Values
-
COMPILE_CONFIGURATION_NAME
public static final String COMPILE_CONFIGURATION_NAME
Deprecated.Users should preferAPI_CONFIGURATION_NAMEorIMPLEMENTATION_CONFIGURATION_NAME.The name of the configuration that is used to declare API or implementation dependencies. This configuration is deprecated.- See Also:
- Constant Field Values
-
COMPILE_ONLY_CONFIGURATION_NAME
public static final String COMPILE_ONLY_CONFIGURATION_NAME
The name of the configuration that is used to declare dependencies which are only required to compile a component, but not at runtime.- See Also:
- Constant Field Values
-
RUNTIME_CONFIGURATION_NAME
public static final String RUNTIME_CONFIGURATION_NAME
Deprecated.Consumers should useRUNTIME_ELEMENTS_CONFIGURATION_NAMEinstead.The name of the "runtime" configuration. This configuration is deprecated and doesn't represent a correct view of the runtime dependencies of a component.- See Also:
- Constant Field Values
-
RUNTIME_ONLY_CONFIGURATION_NAME
public static final String RUNTIME_ONLY_CONFIGURATION_NAME
The name of the runtime only dependencies configuration, used to declare dependencies that should only be found at runtime.- Since:
- 3.4
- See Also:
- Constant Field Values
-
RUNTIME_CLASSPATH_CONFIGURATION_NAME
public static final String RUNTIME_CLASSPATH_CONFIGURATION_NAME
The name of the runtime classpath configuration, used by a component to query its own runtime classpath.- Since:
- 3.4
- See Also:
- Constant Field Values
-
RUNTIME_ELEMENTS_CONFIGURATION_NAME
public static final String RUNTIME_ELEMENTS_CONFIGURATION_NAME
The name of the runtime elements configuration, that should be used by consumers to query the runtime dependencies of a component.- Since:
- 3.4
- See Also:
- Constant Field Values
-
COMPILE_CLASSPATH_CONFIGURATION_NAME
public static final String COMPILE_CLASSPATH_CONFIGURATION_NAME
The name of the compile classpath configuration.- Since:
- 3.4
- See Also:
- Constant Field Values
-
ANNOTATION_PROCESSOR_CONFIGURATION_NAME
@Incubating public static final String ANNOTATION_PROCESSOR_CONFIGURATION_NAME
The name of the annotation processor configuration.- Since:
- 4.6
- See Also:
- Constant Field Values
-
TEST_COMPILE_CONFIGURATION_NAME
public static final String TEST_COMPILE_CONFIGURATION_NAME
- See Also:
- Constant Field Values
-
TEST_IMPLEMENTATION_CONFIGURATION_NAME
public static final String TEST_IMPLEMENTATION_CONFIGURATION_NAME
The name of the test implementation dependencies configuration.- Since:
- 3.4
- See Also:
- Constant Field Values
-
TEST_COMPILE_ONLY_CONFIGURATION_NAME
public static final String TEST_COMPILE_ONLY_CONFIGURATION_NAME
The name of the configuration that should be used to declare dependencies which are only required to compile the tests, but not when running them.- See Also:
- Constant Field Values
-
TEST_RUNTIME_CONFIGURATION_NAME
public static final String TEST_RUNTIME_CONFIGURATION_NAME
Deprecated.UseTEST_RUNTIME_CLASSPATH_CONFIGURATION_NAMEinstead.The name of the configuration that represents the component runtime classpath. This configuration doesn't represent the exact runtime dependencies and therefore is deprecated.- See Also:
- Constant Field Values
-
TEST_RUNTIME_ONLY_CONFIGURATION_NAME
public static final String TEST_RUNTIME_ONLY_CONFIGURATION_NAME
The name of the test runtime only dependencies configuration.- Since:
- 3.4
- See Also:
- Constant Field Values
-
TEST_COMPILE_CLASSPATH_CONFIGURATION_NAME
public static final String TEST_COMPILE_CLASSPATH_CONFIGURATION_NAME
The name of the test compile classpath configuration.- Since:
- 3.4
- See Also:
- Constant Field Values
-
TEST_ANNOTATION_PROCESSOR_CONFIGURATION_NAME
@Incubating public static final String TEST_ANNOTATION_PROCESSOR_CONFIGURATION_NAME
The name of the test annotation processor configuration.- Since:
- 4.6
- See Also:
- Constant Field Values
-
TEST_RUNTIME_CLASSPATH_CONFIGURATION_NAME
public static final String TEST_RUNTIME_CLASSPATH_CONFIGURATION_NAME
The name of the test runtime classpath configuration.- Since:
- 3.4
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
JavaPlugin
@Inject public JavaPlugin(ObjectFactory objectFactory)
-
-