Interface ConnectionVersion4

  • All Known Subinterfaces:
    InternalConnection

    public interface ConnectionVersion4

    Represents a connection to a Gradle implementation.

    The following constraints apply to implementations:

    DO NOT CHANGE THIS INTERFACE - it is part of the cross-version protocol.

    Consumer compatibility: This interface is used by all consumer versions from 1.0-milestone-3.

    Provider compatibility: This interface is implemented by all provider versions from 1.0-milestone-3.

    Since:
    1.0-milestone-3
    • Method Detail

      • stop

        @Deprecated
        void stop()
        Deprecated.
        2.2-rc-1 Use StoppableConnection instead.

        Stops this connection, blocking until complete.

        Consumer compatibility: This method is used by all consumer versions from 1.0-milestone-3.

        Provider compatibility: This method is implemented by all provider versions from 1.0-milestone-3.

        Since:
        1.0-milestone-3
      • getMetaData

        ConnectionMetaDataVersion1 getMetaData()

        Returns the meta-data for this connection. The implementation of this method should be fast, and should continue to work after the connection has been stopped.

        Consumer compatibility: This method is used by all consumer versions from 1.0-milestone-3.

        Provider compatibility: This method is implemented by all provider versions from 1.0-milestone-3.

        Returns:
        The meta-data.
        Since:
        1.0-milestone-3
      • getModel

        @Deprecated
        ProjectVersion3 getModel​(java.lang.Class<? extends ProjectVersion3> type,
                                 BuildOperationParametersVersion1 operationParameters)
                          throws java.lang.UnsupportedOperationException,
                                 java.lang.IllegalStateException

        Fetches a snapshot of the model for the project.

        Consumer compatibility: This method is used by all consumer versions from 1.0-milestone-3 to 1.0-milestone-7. It is also used by later consumers when the provider does not implement newer interfaces. It is not used by consumer versions 2.0 and later.

        Provider compatibility: This method is implemented by all provider versions from 1.0-milestone-3. Provider versions 2.0 and later fail with a 'no longer supported' exception.

        Throws:
        java.lang.UnsupportedOperationException - When the given model type is not supported.
        java.lang.IllegalStateException - When this connection has been stopped.
        Since:
        1.0-milestone-3
      • executeBuild

        @Deprecated
        void executeBuild​(BuildParametersVersion1 buildParameters,
                          BuildOperationParametersVersion1 operationParameters)
                   throws java.lang.IllegalStateException

        Executes a build.

        Consumer compatibility: This method is used by all consumer versions from 1.0-milestone-3 to 1.1. It is also used by later consumers when the provider does not implement newer interfaces. It is not used by consumer versions 2.0 and later.

        Provider compatibility: This method is implemented by all provider versions from 1.0-milestone-3. Provider versions 2.0 and later fail with a 'no longer supported' exception.

        Parameters:
        buildParameters - The parameters for the build.
        Throws:
        java.lang.IllegalStateException - When this connection has been stopped.
        Since:
        1.0-milestone-3