Package stroom.docref

Class DocRef.Builder

  • Enclosing class:
    DocRef
    public static class DocRef.Builder
extends java.lang.Object
    Builder for constructing a docRef

    • Constructor Summary

      Constructors 
      Constructor Description
      Builder()  

    • Method Summary

      Modifier and Type Method Description
      DocRef build()  
      DocRef.Builder name​(java.lang.String value)  
      DocRef.Builder type​(java.lang.String value)  
      DocRef.Builder uuid​(java.lang.String value)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • type

        public DocRef.Builder type​(java.lang.String value)
        Parameters:
        value - The type of the 'document' that this docRef points to an instance of. Supported types are defined outside of this documentation.
        Returns:
        The DocRef.Builder, enabling method chaining

      • uuid

        public DocRef.Builder uuid​(java.lang.String value)
        Parameters:
        value - A UUID as generated by UUID.randomUUID()
        Returns:
        The DocRef.Builder, enabling method chaining

      • name

        public DocRef.Builder name​(java.lang.String value)
        Parameters:
        value - The name of the 'document' being referenced
        Returns:
        The DocRef.Builder, enabling method chaining

      • build

        public DocRef build()