Interface Reference

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  Reference.ReferenceType
      The reference type as an enum.
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default void checkHash()
      Validation rule using Validation.validateHash(String).
      static Reference fromPathString​(java.lang.String value, Reference.ReferenceType parseAsType)  
      @Pattern(regexp="^[0-9a-fA-F]{8,64}$",message="Hash must consist of the hex representation of 4-32 bytes") @Pattern(regexp="^[0-9a-fA-F]{8,64}$",message="Hash must consist of the hex representation of 4-32 bytes") java.lang.String getHash()
      backend system id.
      ReferenceMetadata getMetadata()
      Returns a ReferenceMetadata instance that contains additional metadata about this reference.
      @NotBlank @NotBlank @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9_-])?$",message="Reference name must start with a letter, followed by letters, digits, one of the ./_- characters, not end with a slash or dot, not contain \'..\'") @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9_-])?$",message="Reference name must start with a letter, followed by letters, digits, one of the ./_- characters, not end with a slash or dot, not contain \'..\'") java.lang.String getName()
      Human-readable reference name.
      Reference.ReferenceType getType()  
      default java.lang.String toPathString()  
      static java.lang.String toPathString​(java.lang.String name, java.lang.String hash)  
    • Method Detail

      • getName

        @NotBlank
        @NotBlank
        @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9_-])?$",
                 message="Reference name must start with a letter, followed by letters, digits, one of the ./_- characters, not end with a slash or dot, not contain \'..\'")
        @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9_-])?$",
                 message="Reference name must start with a letter, followed by letters, digits, one of the ./_- characters, not end with a slash or dot, not contain \'..\'")
        @NotBlank @NotBlank @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9_-])?$",message="Reference name must start with a letter, followed by letters, digits, one of the ./_- characters, not end with a slash or dot, not contain \'..\'") @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9_-])?$",message="Reference name must start with a letter, followed by letters, digits, one of the ./_- characters, not end with a slash or dot, not contain \'..\'") java.lang.String getName()
        Human-readable reference name.
      • getHash

        @Pattern(regexp="^[0-9a-fA-F]{8,64}$",
                 message="Hash must consist of the hex representation of 4-32 bytes")
        @Pattern(regexp="^[0-9a-fA-F]{8,64}$",
                 message="Hash must consist of the hex representation of 4-32 bytes")
        @Pattern(regexp="^[0-9a-fA-F]{8,64}$",message="Hash must consist of the hex representation of 4-32 bytes") @Pattern(regexp="^[0-9a-fA-F]{8,64}$",message="Hash must consist of the hex representation of 4-32 bytes") java.lang.String getHash()
        backend system id. Usually the 32-byte hash of the commit this reference points to.
      • getMetadata

        @Nullable
        @Nullable
        ReferenceMetadata getMetadata()
        Returns a ReferenceMetadata instance that contains additional metadata about this reference. Note that this is only added by the server when explicitly requested by the client.
        Returns:
        A ReferenceMetadata instance that contains additional metadata about this reference. Note that this is only added by the server when explicitly requested by the client.
      • toPathString

        default java.lang.String toPathString()
      • toPathString

        static java.lang.String toPathString​(java.lang.String name,
                                             java.lang.String hash)