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

Class PrefixesTreatedAsWithdrawTlvBuilder

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

   
     PrefixesTreatedAsWithdrawTlv createPrefixesTreatedAsWithdrawTlv(int fooXyzzy, int barBaz) {
         return new PrefixesTreatedAsWithdrawTlvBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PrefixesTreatedAsWithdrawTlvBuilder

      public PrefixesTreatedAsWithdrawTlvBuilder()
      Construct an empty builder.

    • PrefixesTreatedAsWithdrawTlvBuilder

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

    • PrefixesTreatedAsWithdrawTlvBuilder

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

    • PrefixesTreatedAsWithdrawTlvBuilder

      public PrefixesTreatedAsWithdrawTlvBuilder(PrefixesTreatedAsWithdrawTlv base)
      Construct a builder initialized with state from specified PrefixesTreatedAsWithdrawTlv.
      Parameters:
      base - PrefixesTreatedAsWithdrawTlv 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 PrefixesTreatedAsWithdrawTlv empty()
      Get empty instance of PrefixesTreatedAsWithdrawTlv.
      Returns:
      An empty PrefixesTreatedAsWithdrawTlv

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