Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.hello

Class ElementsBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.hello.ElementsBuilder
@Generated("mdsal-binding-generator") public class ElementsBuilder extends Object
Class that builds Elements 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: 

   
     Elements createElements(int fooXyzzy, int barBaz) {
         return new ElementsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

This pattern is supported by the immutable nature of Elements, 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

    • ElementsBuilder

      public ElementsBuilder()
      Construct an empty builder.

    • ElementsBuilder

      public ElementsBuilder(OfHelloElementHeader arg)
      Construct a new builder initialized from specified OfHelloElementHeader.
      Parameters:
      arg - OfHelloElementHeader from which the builder should be initialized

    • ElementsBuilder

      public ElementsBuilder(Elements base)
      Construct a builder initialized with state from specified Elements.
      Parameters:
      base - Elements 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

    • getType

      public HelloElementType getType()
      Return current value associated with the property corresponding to OfHelloElementHeader.getType().
      Returns:
      current value

    • getVersionBitmap

      public List<Boolean> getVersionBitmap()
      Return current value associated with the property corresponding to Elements.getVersionBitmap().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Elements>> 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

    • setType

      public ElementsBuilder setType(HelloElementType value)
      Set the property corresponding to OfHelloElementHeader.getType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setVersionBitmap

      public ElementsBuilder setVersionBitmap(List<Boolean> values)
      Set the property corresponding to Elements.getVersionBitmap() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

      public ElementsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Elements> 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 ElementsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Elements>> 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 Elements build()
      A new Elements instance.
      Returns:
      A new Elements instance.