Package com.atlassian.bamboo.v2.build.requirement

Interface ImmutableRequirement

All Superinterfaces:
BambooIdProvider
All Known Subinterfaces:
Requirement, RequirementDetails
All Known Implementing Classes:
AgentAssignmentRequirement, RequirementDetailsImpl, RequirementImpl
public interface ImmutableRequirement extends BambooIdProvider
Read only view of a requirement
Since:
v5.6

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()
      Represents the requirement. Must match exactly to the Capability getKey().
      Returns:

    • getMatchValue

      @Nullable @Nullable String getMatchValue()
      A match requirement value. Even "EXISTS" matches are represented as a regex match with match value ".*"

      The regex must match the Capability value.

      Returns:
      the value to match.

    • getTypeOfMatch

      @NotNull @NotNull ImmutableRequirement.MatchType getTypeOfMatch()
      Returns:
      representing the type of match

    • isReadonly

      Boolean isReadonly()
      If a requirement is readonly, it cannot be removed through the UI (the backend can do what it wants, however)
      Returns:
      true if the requirement cannot be removed or edited via the UI.

    • getOwnerId

      long getOwnerId()
      The identifier of this Requirement that is used to identify it uniquely for all Requirements created by getPluginModuleKey()
      Returns:
      ownerId

    • getPluginModuleKey

      @Nullable @Nullable String getPluginModuleKey()
      The ModuleDescriptor.getKey() that is responsible for the Lifecycle of this Requirement
      Returns:
      pluginKey

    • isRegexMatch

      boolean isRegexMatch()
      Is this a regex match requirement or exact match requirement.
      Returns: