java.lang.Object
- org.projectnessie.model.Validation

public final class Validation
extends Object

Collection of validation rules.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`FORBIDDEN_REF_NAME_MESSAGE`
`static Set<String>`	`FORBIDDEN_REF_NAMES`
`static String`	`HASH_MESSAGE`
`static Pattern`	`HASH_PATTERN`
`static String`	`HASH_RAW_REGEX`
`static String`	`HASH_REGEX`
`static String`	`REF_NAME_MESSAGE`
`static String`	`REF_NAME_OR_HASH_MESSAGE`
`static Pattern`	`REF_NAME_OR_HASH_PATTERN`
`static String`	`REF_NAME_OR_HASH_REGEX`
`static Pattern`	`REF_NAME_PATTERN`
`static String`	`REF_NAME_RAW_REGEX`
`static String`	`REF_NAME_REGEX`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static boolean`	`isForbiddenReferenceName(String ref)`	Checks whether `ref` represents a forbidden reference name (`HEAD` or `DETACHED`) or could represent a commit-ID.
`static boolean`	`isValidHash(String hash)`	Just checks whether a string is a valid hash, but doesn't throw an exception.
`static boolean`	`isValidReferenceName(String referenceName)`	Just checks whether a string is a valid reference-name, but doesn't throw an exception.
`static boolean`	`isValidReferenceNameOrHash(String ref)`	Just checks whether a string is a valid reference-name (as per `isValidReferenceName(String)`) or a valid hash (as per `isValidHash(String)`).
`static String`	`validateForbiddenReferenceName(String ref)`	Throws an `IllegalArgumentException` if `ref` represents a forbidden reference name, see `isForbiddenReferenceName(String)`.
`static String`	`validateHash(String referenceName)`	Validates whether a string is a valid hash.
`static String`	`validateReferenceName(String referenceName)`	Validates whether a string is a valid reference-name.
`static String`	`validateReferenceNameOrHash(String ref)`	Validates whether a string is a valid reference name or hash.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HASH_RAW_REGEX
```
public static final String HASH_RAW_REGEX
```
    See Also:
    
    Constant Field Values
  - HASH_REGEX
```
public static final String HASH_REGEX
```
    See Also:
    
    Constant Field Values
  - REF_NAME_RAW_REGEX
```
public static final String REF_NAME_RAW_REGEX
```
    See Also:
    
    Constant Field Values
  - REF_NAME_REGEX
```
public static final String REF_NAME_REGEX
```
    See Also:
    
    Constant Field Values
  - REF_NAME_OR_HASH_REGEX
```
public static final String REF_NAME_OR_HASH_REGEX
```
    See Also:
    
    Constant Field Values
  - HASH_PATTERN
```
public static final Pattern HASH_PATTERN
```
  - REF_NAME_PATTERN
```
public static final Pattern REF_NAME_PATTERN
```
  - REF_NAME_OR_HASH_PATTERN
```
public static final Pattern REF_NAME_OR_HASH_PATTERN
```
  - HASH_MESSAGE
```
public static final String HASH_MESSAGE
```
    See Also:
    
    Constant Field Values
  - REF_NAME_MESSAGE
```
public static final String REF_NAME_MESSAGE
```
    See Also:
    
    Constant Field Values
  - REF_NAME_OR_HASH_MESSAGE
```
public static final String REF_NAME_OR_HASH_MESSAGE
```
    See Also:
    
    Constant Field Values
  - FORBIDDEN_REF_NAME_MESSAGE
```
public static final String FORBIDDEN_REF_NAME_MESSAGE
```
    See Also:
    
    Constant Field Values
  - FORBIDDEN_REF_NAMES
```
public static final Set<String> FORBIDDEN_REF_NAMES
```
- Method Detail
  - isValidReferenceName
```
public static boolean isValidReferenceName(String referenceName)
```
    Just checks whether a string is a valid reference-name, but doesn't throw an exception.
    
    See Also:
    
    validateReferenceName(String)
  - isValidHash
```
public static boolean isValidHash(String hash)
```
    Just checks whether a string is a valid hash, but doesn't throw an exception.
    
    See Also:
    
    validateHash(String)
  - isValidReferenceNameOrHash
```
public static boolean isValidReferenceNameOrHash(String ref)
```
    Just checks whether a string is a valid reference-name (as per isValidReferenceName(String)) or a valid hash (as per isValidHash(String)).
  - validateReferenceName
```
public static String validateReferenceName(String referenceName)
                                    throws IllegalArgumentException
```
    Validates whether a string is a valid reference-name.
    The rules are: "start with a letter, followed by letters, digits, one of the ./_- characters, not end with a slash or dot, not contain \'..\'"
    
    Parameters:
    
    referenceName - the reference name string to test.
    
    Throws:
    
    IllegalArgumentException
  - validateHash
```
public static String validateHash(String referenceName)
                           throws IllegalArgumentException
```
    Validates whether a string is a valid hash.
    The rules are: "consist of the hex representation of 4-32 bytes"
    
    Parameters:
    
    referenceName - the reference name string to test.
    
    Throws:
    
    IllegalArgumentException
  - validateReferenceNameOrHash
```
public static String validateReferenceNameOrHash(String ref)
                                          throws IllegalArgumentException
```
    Validates whether a string is a valid reference name or hash.
    See validateReferenceName(String) and validateHash(String) for the rules.
    
    Parameters:
    
    ref - the reference name string to test.
    
    Throws:
    
    IllegalArgumentException
  - isForbiddenReferenceName
```
public static boolean isForbiddenReferenceName(String ref)
```
    Checks whether ref represents a forbidden reference name (HEAD or DETACHED) or could represent a commit-ID.
    
    Parameters:
    
    ref - reference name to check
    
    Returns:
    
    true, if forbidden
  - validateForbiddenReferenceName
```
public static String validateForbiddenReferenceName(String ref)
                                             throws IllegalArgumentException
```
    Throws an IllegalArgumentException if ref represents a forbidden reference name, see isForbiddenReferenceName(String).
    
    Parameters:
    
    ref - reference name to check
    
    Returns:
    
    ref
    
    Throws:
    
    IllegalArgumentException

Class Validation

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HASH_RAW_REGEX

HASH_REGEX

REF_NAME_RAW_REGEX

REF_NAME_REGEX

REF_NAME_OR_HASH_REGEX

HASH_PATTERN

REF_NAME_PATTERN

REF_NAME_OR_HASH_PATTERN

HASH_MESSAGE

REF_NAME_MESSAGE

REF_NAME_OR_HASH_MESSAGE

FORBIDDEN_REF_NAME_MESSAGE

FORBIDDEN_REF_NAMES

Method Detail

isValidReferenceName

isValidHash

isValidReferenceNameOrHash

validateReferenceName

validateHash

validateReferenceNameOrHash

isForbiddenReferenceName

validateForbiddenReferenceName