Package org.projectnessie.model

Class Validation

  • public final class Validation
extends java.lang.Object
    Collection of validation rules.

    • Field Detail

      • REF_NAME_RAW_REGEX

        public static final java.lang.String REF_NAME_RAW_REGEX
        See Also:
        Constant Field Values

      • REF_NAME_OR_HASH_REGEX

        public static final java.lang.String REF_NAME_OR_HASH_REGEX
        See Also:
        Constant Field Values

      • HASH_PATTERN

        public static final java.util.regex.Pattern HASH_PATTERN

      • REF_NAME_PATTERN

        public static final java.util.regex.Pattern REF_NAME_PATTERN

      • REF_NAME_OR_HASH_PATTERN

        public static final java.util.regex.Pattern REF_NAME_OR_HASH_PATTERN

      • REF_NAME_MESSAGE

        public static final java.lang.String REF_NAME_MESSAGE
        See Also:
        Constant Field Values

      • REF_NAME_OR_HASH_MESSAGE

        public static final java.lang.String REF_NAME_OR_HASH_MESSAGE
        See Also:
        Constant Field Values

      • FORBIDDEN_REF_NAME_MESSAGE

        public static final java.lang.String FORBIDDEN_REF_NAME_MESSAGE
        See Also:
        Constant Field Values

      • FORBIDDEN_REF_NAMES

        public static final java.util.Set<java.lang.String> FORBIDDEN_REF_NAMES

    • Method Detail

      • isValidReferenceName

        public static boolean isValidReferenceName​(java.lang.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​(java.lang.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​(java.lang.String ref)
        Just checks whether a string is a valid reference-name (as per isValidReferenceName(String)) or a valid hash (as per isValidHash(String)).

      • validateHash

        public static java.lang.String validateHash​(java.lang.String referenceName)
                                     throws java.lang.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:
        java.lang.IllegalArgumentException

      • validateReferenceNameOrHash

        public static java.lang.String validateReferenceNameOrHash​(java.lang.String ref)
                                                    throws java.lang.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:
        java.lang.IllegalArgumentException

      • isForbiddenReferenceName

        public static boolean isForbiddenReferenceName​(java.lang.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 java.lang.String validateForbiddenReferenceName​(java.lang.String ref)
                                                       throws java.lang.IllegalArgumentException
        Throws an IllegalArgumentException if ref represents a forbidden reference name, see isForbiddenReferenceName(String).
        Parameters:
        ref - reference name to check
        Returns:
        ref
        Throws:
        java.lang.IllegalArgumentException