Package org.gradle.api.plugins

Class JavaPlugin

java.lang.Object
org.gradle.api.plugins.JavaPlugin
All Implemented Interfaces:
Plugin<Project>
public abstract class JavaPlugin extends Object implements Plugin<Project>

A Plugin which compiles and tests Java source, and assembles it into a JAR file.

This plugin creates a built-in test suite named test that represents the Test task for Java projects.
See Also:

  • Field Details

    • PROCESS_RESOURCES_TASK_NAME

      public static final String PROCESS_RESOURCES_TASK_NAME
      The name of the task that processes resources.
      See Also:

    • 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:

    • COMPILE_JAVA_TASK_NAME

      public static final String COMPILE_JAVA_TASK_NAME
      The name of the task which compiles Java sources.
      See Also:

    • 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:

    • 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:

    • 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:

    • TEST_TASK_NAME

      public static final String TEST_TASK_NAME
      The name of the task which triggers execution of tests.
      See Also:

    • JAR_TASK_NAME

      public static final String JAR_TASK_NAME
      The name of the task which generates the component main jar.
      See Also:

    • JAVADOC_TASK_NAME

      public static final String JAVADOC_TASK_NAME
      The name of the task which generates the component javadoc.
      See Also:

    • 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:

    • 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:

    • API_ELEMENTS_CONFIGURATION_NAME

      public static final String API_ELEMENTS_CONFIGURATION_NAME
      The name of the configuration to define the API elements of a component. That is, the dependencies which are required to compile against that component.
      Since:
      3.4
      See Also:

    • 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:

    • COMPILE_ONLY_API_CONFIGURATION_NAME

      public static final String COMPILE_ONLY_API_CONFIGURATION_NAME
      The name of the configuration to define the API elements of a component that are required to compile a component, but not at runtime.
      Since:
      6.7
      See Also:

    • 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:

    • 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:

    • 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:

    • JAVADOC_ELEMENTS_CONFIGURATION_NAME

      public static final String JAVADOC_ELEMENTS_CONFIGURATION_NAME
      The name of the javadoc elements configuration.
      Since:
      6.0
      See Also:

    • SOURCES_ELEMENTS_CONFIGURATION_NAME

      public static final String SOURCES_ELEMENTS_CONFIGURATION_NAME
      The name of the sources elements configuration.
      Since:
      6.0
      See Also:

    • COMPILE_CLASSPATH_CONFIGURATION_NAME

      public static final String COMPILE_CLASSPATH_CONFIGURATION_NAME
      The name of the compile classpath configuration.
      Since:
      3.4
      See Also:

    • ANNOTATION_PROCESSOR_CONFIGURATION_NAME

      public static final String ANNOTATION_PROCESSOR_CONFIGURATION_NAME
      The name of the annotation processor configuration.
      Since:
      4.6
      See Also:

    • 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:

    • 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:

    • 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:

    • 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:

    • TEST_ANNOTATION_PROCESSOR_CONFIGURATION_NAME

      public static final String TEST_ANNOTATION_PROCESSOR_CONFIGURATION_NAME
      The name of the test annotation processor configuration.
      Since:
      4.6
      See Also:

    • 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:

  • Constructor Details

    • JavaPlugin

      @Inject public JavaPlugin()

  • Method Details

    • apply

      public void apply(Project project)
      Description copied from interface: Plugin
      Apply this plugin to the given target object.
      Specified by:
      apply in interface Plugin<Project>
      Parameters:
      project - The target object