org.azyva.dragom.model.plugin

Interface SelectDynamicVersionPlugin

All Superinterfaces:

ModulePlugin, NodePlugin

public interface SelectDynamicVersionPlugin
extends ModulePlugin

This plugin is used by tools when a dynamic Version needs to be selected. It is responsible for selecting what that Version will be. It is up to the plugin implementation to use whatever strategy is appropriate for selecting the Version. The strategy can include interacting with the user through the UserInteractionCallbackPlugin plugin within the ExecContext. The ScmPlugin can also be interrogated for existing Versions if the strategy calls for it. The plugin is not responsible for actually creating the Version. The new Version can actually exist if the strategy can involve reusing existing Version.

Author:

David Raymond

Method Summary

Modifier and Type	Method and Description
Version	selectDynamicVersion(Version version, ByReference<Version> byReferenceVersionBase, ReferencePath referencePath) Selects a dynamic Version based on an existing Version which can be static (e.g., hotfix Version based on a release Version) or dynamic (e.g., feature Version based on a project Version).

Methods inherited from interface org.azyva.dragom.model.plugin.ModulePlugin

getModule

Methods inherited from interface org.azyva.dragom.model.plugin.NodePlugin

getNode

Method Detail

selectDynamicVersion

Version selectDynamicVersion(Version version,
                             ByReference<Version> byReferenceVersionBase,
                             ReferencePath referencePath)

Selects a dynamic Version based on an existing Version which can be static (e.g., hotfix Version based on a release Version) or dynamic (e.g., feature Version based on a project Version). The caller is responsible for verifying if the selected dynamic Version exists. If it does the Version returned in byReferenceVersionBase (if any) must be ignored. But the caller must not infer whether the dynamic Version exists or not based on whether a base Version was returned. It may be the case that the existing Version is already dynamic and that no new Version needs to be created. In that case version must be returned.

Parameters:

version - Original version.

byReferenceVersionBase - The base Version to use for creating the new dynamic Version will be stored there.

referencePath - ReferencePath of the ModuleVersion. Implementations can use this information to, for example, validate that the ModuleVersion exists within a ReferencePath that contains only static Versions (for hotfixes).

Returns:

Dynamic Version. May be the same as the original version. Can be null to indicate to the caller that the existing Version should not be changed.