Package com._1c.g5.v8.dt.team

Interface IDevelopmentProcessContributor

  • public interface IDevelopmentProcessContributor
    Development process contributor allows to contribute to the development process creation and deletion process. Contributors are defined by extensions in plugin.xml.

    Following is an example definition of a development process contributor extension: 

     <extension point="com._1c.g5.v8.dt.team.developmentProcess">

    <!-- this contributor will be executed for every development process creation -->
    <contributor class="com.example.SomeVcsBranchProcessContributor"/>

    <!-- this contributor will be executed for development process creation only with the provided deployment type -->
    <contributor
       class="com.exampe.SomeDevelopmentEnvironmentProcessContributor"
       deploymentType="com.exampe.deploymentType.someType">
    </contributor>

 </extension>

    Defined development process contributor will be aggregated and executed during development process creation based on the provided deployment type.

    This interface is intended to be implemented and registered by clients. Instances are not intended to be explicitly used by client. Clients may use IDevelopmentProcessManager instead.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void delete​(IIssueDescriptor issue, org.eclipse.core.resources.IProject project, DevelopmentOptions options, org.eclipse.core.runtime.IProgressMonitor monitor)
      Contributes development process deletion work the development environment for the provided issue descriptor.
      void prepare​(String name, org.eclipse.core.resources.IProject project, IIssueType issueType, DevelopmentOptions options, org.eclipse.core.runtime.IProgressMonitor monitor)
      Prepares development process contribution work to the creation process.
      void process​(String name, org.eclipse.core.resources.IProject project, IIssueType issueType, DevelopmentOptions options, org.eclipse.core.runtime.IProgressMonitor monitor)
      Contributes development process creation work to the creation process.

    • Method Detail

      • prepare

        void prepare​(String name,
             org.eclipse.core.resources.IProject project,
             IIssueType issueType,
             DevelopmentOptions options,
             org.eclipse.core.runtime.IProgressMonitor monitor)
      throws DevelopmentProcessException
        Prepares development process contribution work to the creation process. Method is called before process method.

        Based on provided development options, clients may collect any essential information if needed before real changes of all contributors are applied.

        Parameters:
        name - the name of the creating issue, cannot be null
        project - the project to create issure for, cannot be null
        issueType - the type of the creating issue, cannot be null
        options - the development options to create development process with, cannot be null
        monitor - the progress monitor to report progress to and check cancellation status, cannot be null
        Throws:
        DevelopmentProcessException - if development process creation failed
        See Also:
        DevelopmentOptions

      • process

        void process​(String name,
             org.eclipse.core.resources.IProject project,
             IIssueType issueType,
             DevelopmentOptions options,
             org.eclipse.core.runtime.IProgressMonitor monitor)
      throws DevelopmentProcessException
        Contributes development process creation work to the creation process. Method is called afrer prepare method.

        Based on provided development options, clients may implement development VCS branch creation or development environment creation and configuration. If creation process contribution failed with some reason clients should throw DevelopmentProcessException.

        Parameters:
        name - the name of the creating issue, cannot be null
        project - the project to create issure for, cannot be null
        issueType - the type of the creating issue, cannot be null
        options - the development options to create development process with, cannot be null
        monitor - the progress monitor to report progress to and check cancellation status, cannot be null
        Throws:
        DevelopmentProcessException - if development process creation failed
        See Also:
        DevelopmentOptions

      • delete

        void delete​(IIssueDescriptor issue,
            org.eclipse.core.resources.IProject project,
            DevelopmentOptions options,
            org.eclipse.core.runtime.IProgressMonitor monitor)
     throws DevelopmentProcessException
        Contributes development process deletion work the development environment for the provided issue descriptor.
        Parameters:
        issue - the issue to delete development environment for, cannot be null
        project - the workspace project, cannot be null
        options - the development options to delete development process with, cannot be null
        monitor - the progress monitor to report progress to and check cancellation status, cannot be null
        Throws:
        DevelopmentProcessException - if development process delete failed