Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev220720.graph.topology.graph

Class EdgeBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev220720.graph.topology.graph.EdgeBuilder
@Generated("mdsal-binding-generator") public class EdgeBuilder extends Object
Class that builds Edge instances. Overall design of the class is that of a fluent interface, where method chaining is used.

In general, this class is supposed to be used like this template: 

   
     Edge createEdge(int fooXyzzy, int barBaz) {
         return new EdgeBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

This pattern is supported by the immutable nature of Edge, as instances can be freely passed around without worrying about synchronization issues.

As a side note: method chaining results in:

  • very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is on the stack, so further method invocations just need to fill method arguments for the next method invocation, which is terminated by build(), which is then returned from the method
  • better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
  • better optimization opportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
See Also:

  • Constructor Details

    • EdgeBuilder

      public EdgeBuilder()
      Construct an empty builder.

    • EdgeBuilder

      public EdgeBuilder(Edge arg)
      Construct a new builder initialized from specified Edge.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev220720.Edge from which the builder should be initialized

    • EdgeBuilder

      public EdgeBuilder(Edge base)
      Construct a builder initialized with state from specified Edge.
      Parameters:
      base - Edge from which the builder should be initialized

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
      Set fields from given grouping argument. Valid argument is instance of one of following types:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • key

      public EdgeKey key()
      Return current value associated with the property corresponding to Edge.key().
      Returns:
      current value

    • getEdgeAttributes

      public EdgeAttributes getEdgeAttributes()
      Return current value associated with the property corresponding to Edge.getEdgeAttributes().
      Returns:
      current value

    • getEdgeId

      public org.opendaylight.yangtools.yang.common.Uint64 getEdgeId()
      Return current value associated with the property corresponding to Edge.getEdgeId().
      Returns:
      current value

    • getLocalVertexId

      public org.opendaylight.yangtools.yang.common.Uint64 getLocalVertexId()
      Return current value associated with the property corresponding to Edge.getLocalVertexId().
      Returns:
      current value

    • getName

      public String getName()
      Return current value associated with the property corresponding to Edge.getName().
      Returns:
      current value

    • getRemoteVertexId

      public org.opendaylight.yangtools.yang.common.Uint64 getRemoteVertexId()
      Return current value associated with the property corresponding to Edge.getRemoteVertexId().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Edge>> E$$ augmentation(Class<E$$> augmentationType)
      Return the specified augmentation, if it is present in this builder.
      Type Parameters:
      E$$ - augmentation type
      Parameters:
      augmentationType - augmentation type class
      Returns:
      Augmentation object from this builder, or null if not present
      Throws:
      NullPointerException - if augmentType is null

    • withKey

      public EdgeBuilder withKey(EdgeKey key)
      Set the key value corresponding to Edge.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setEdgeAttributes

      public EdgeBuilder setEdgeAttributes(EdgeAttributes value)
      Set the property corresponding to Edge.getEdgeAttributes() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setEdgeId

      public EdgeBuilder setEdgeId(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to Edge.getEdgeId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLocalVertexId

      public EdgeBuilder setLocalVertexId(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to Edge.getLocalVertexId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setName

      public EdgeBuilder setName(String value)
      Set the property corresponding to Edge.getName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRemoteVertexId

      public EdgeBuilder setRemoteVertexId(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to Edge.getRemoteVertexId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public EdgeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Edge> augmentation)
      Add an augmentation to this builder's product.
      Parameters:
      augmentation - augmentation to be added
      Returns:
      this builder
      Throws:
      NullPointerException - if augmentation is null

    • removeAugmentation

      public EdgeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Edge>> augmentationType)
      Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
      Parameters:
      augmentationType - augmentation type to be removed
      Returns:
      this builder

    • build

      public @NonNull Edge build()
      A new Edge instance.
      Returns:
      A new Edge instance.