com.atlassian.bamboo.validation

Interface ValidationService

public interface ValidationService

Methods for validation of standard Fields

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ValidationService.ValidationFunction Function to call once the object is locked.
static class	ValidationService.ValidationType

Field Summary

Fields

Modifier and Type	Field and Description
static String	FULL_JOB_KEY_REGEXP Regular expression matching a full job key.
static String	PARTIAL_JOB_KEY_REGEXP Regular expression matching a partial job key.

Method Summary

Methods

Modifier and Type	Method and Description
ErrorCollection	validateDescription(String fieldName, String description) Validate the description field of any object.
ErrorCollection	validateKey(String fieldName, ValidationService.ValidationType type, String key, ValidationService.ValidationFunction... functions) Validate any String against Bamboo's generic rules for keys.
ErrorCollection	validateName(String fieldName, String errorPrefix, String name) Validate any String against Bamboo's generic rules for names.

Field Detail

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:

Constant Field Values

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:

Constant Field Values

Method Detail

validateKey

@NotNull
ErrorCollection validateKey(@NotNull
                                  String fieldName,
                                  @NotNull
                                  ValidationService.ValidationType type,
                                  @Nullable
                                  String key,
                                  ValidationService.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.

validateName

@NotNull
ErrorCollection validateName(@NotNull
                                   String fieldName,
                                   @NotNull
                                   String errorPrefix,
                                   @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
ErrorCollection validateDescription(@NotNull
                                          String fieldName,
                                          @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