Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.stat.tlvs

Class InvalidatedClusterListLoopTlvBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.stat.tlvs.InvalidatedClusterListLoopTlvBuilder
@Generated("mdsal-binding-generator") public class InvalidatedClusterListLoopTlvBuilder extends Object
Class that builds InvalidatedClusterListLoopTlv 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: 

   
     InvalidatedClusterListLoopTlv createInvalidatedClusterListLoopTlv(int fooXyzzy, int barBaz) {
         return new InvalidatedClusterListLoopTlvBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • InvalidatedClusterListLoopTlvBuilder

      public InvalidatedClusterListLoopTlvBuilder()
      Construct an empty builder.

    • InvalidatedClusterListLoopTlvBuilder

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

    • InvalidatedClusterListLoopTlvBuilder

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

    • InvalidatedClusterListLoopTlvBuilder

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

    • empty

      public static @NonNull InvalidatedClusterListLoopTlv empty()
      Get empty instance of InvalidatedClusterListLoopTlv.
      Returns:
      An empty InvalidatedClusterListLoopTlv

    • getCount

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getCount()
      Return current value associated with the property corresponding to CountTlv.getCount().
      Returns:
      current value

    • augmentation

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

    • setCount

      public InvalidatedClusterListLoopTlvBuilder setCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
      Set the property corresponding to CountTlv.getCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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