Package com.atlassian.bamboo.validation

Interface ValidationService

All Known Implementing Classes:
ValidationServiceImpl
public interface ValidationService
Methods for validation of standard fields

  • Field Details

    • FULL_JOB_KEY_REGEXP

      static final String FULL_JOB_KEY_REGEXP
      Regular expression matching a full job key.

      Matches exactly three groups of an uppercase letter followed by one or more uppercase alphanumeric characters, with each group separated by a hyphen (-).

      Examples:

      AB-CDE-FG1

      See Also:

    • CHAIN_KEY_REGEXP

      static final String CHAIN_KEY_REGEXP
      Regular expression matching a full Chain key.

      Matches exactly two groups of an uppercase letter followed by one or more uppercase alphanumeric characters, with each group separated by a hyphen (-).

      Examples:

      AB-CDE

      See Also:

    • PROJECT_KEY_REGEXP

      static final String PROJECT_KEY_REGEXP
      Regular expression matching a Project key.

      Matches an uppercase letter followed by one or more uppercase alphanumeric characters.

      Examples:

      PROJ1

    • PARTIAL_JOB_KEY_REGEXP

      static final String PARTIAL_JOB_KEY_REGEXP
      Regular expression matching a partial job key.

      Matches an uppercase letter followed by one or more uppercase alphanumeric characters.

      Examples:

      ABC1

      See Also:

  • Method Details

    • validateKey

      @NotNull @NotNull ErrorCollection validateKey(@NotNull @NotNull String fieldName, @NotNull @NotNull ValidationService.ValidationType type, @Nullable @Nullable String key, ValidationFunction... functions)
      Validate any String against Bamboo's generic rules for keys.
      Parameters:
      fieldName - the name of the field to add the errors to.
      type - the ValidationService.ValidationType the key pertains to.
      key - the actual string to validate.
      functions - additional validation functions to run if all generic rules are satisfied. Functions are run in the order they are provided. If a function adds an error to the error collection, subsequent functions will not be run.
      See Also:

    • validateJobKey

      @NotNull @NotNull ErrorCollection validateJobKey(@NotNull @NotNull String fieldName, @Nullable @Nullable String jobKey, ValidationFunction... functions)
      Verify any String that it is a valid job key.
      Parameters:
      fieldName - the name of the field to add the errors to.
      jobKey - the actual string to validate.
      functions - additional validation functions to run if all generic rules are satisfied. Functions are run in the order they are provided. If a function adds an error to the error collection, subsequent functions will not be run.
      See Also:

    • validateChainKey

      @NotNull @NotNull ErrorCollection validateChainKey(@NotNull @NotNull String fieldName, @Nullable @Nullable String chainKey, ValidationFunction... functions)
      Verify any String that it is a valid chain key.
      Parameters:
      fieldName - the name of the field to add the errors to.
      chainKey - the actual string to validate.
      functions - additional validation functions to run if all generic rules are satisfied. Functions are run in the order they are provided. If a function adds an error to the error collection, subsequent functions will not be run.
      See Also:

    • validateProjectKey

      @NotNull @NotNull ErrorCollection validateProjectKey(@NotNull @NotNull String fieldName, @Nullable @Nullable String projectKey, ValidationFunction... functions)
      Verify any String that it is a valid Project key.
      Parameters:
      fieldName - the name of the field to add the errors to
      projectKey - the actual string to validate
      functions - additional validation functions to run if all generic rules are satisfied. Functions are run in the order they are provided. If a function adds an error to the error collection, subsequent functions will not be run.
      See Also:

    • validateName

      @NotNull @NotNull ErrorCollection validateName(@NotNull @NotNull String fieldName, @NotNull @NotNull String errorPrefix, @Nullable @Nullable String name)
      Validate any String against Bamboo's generic rules for names.
      Parameters:
      fieldName - the name of the field to add the errors to
      errorPrefix - the prefix to put in front of the standardised error keys. (e.g. "plan", "chain")
      name - the actual string to validate

    • validateDescription

      @NotNull @NotNull ErrorCollection validateDescription(@NotNull @NotNull String fieldName, @Nullable @Nullable String description)
      Validate the description field of any object. All it really does is check length
      Parameters:
      fieldName - the name of the field to add the errors to
      description - the actual text to validate