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

Class PerAfiSafiLocRibTlvBuilder

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

   
     PerAfiSafiLocRibTlv createPerAfiSafiLocRibTlv(int fooXyzzy, int barBaz) {
         return new PerAfiSafiLocRibTlvBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PerAfiSafiLocRibTlvBuilder

      public PerAfiSafiLocRibTlvBuilder()
      Construct an empty builder.

    • PerAfiSafiLocRibTlvBuilder

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

    • PerAfiSafiLocRibTlvBuilder

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

    • PerAfiSafiLocRibTlvBuilder

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

    • PerAfiSafiLocRibTlvBuilder

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

    • getAfi

      public AddressFamily getAfi()
      Return current value associated with the property corresponding to BgpTableType.getAfi().
      Returns:
      current value

    • getCount

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

    • getSafi

      public SubsequentAddressFamily getSafi()
      Return current value associated with the property corresponding to BgpTableType.getSafi().
      Returns:
      current value

    • augmentation

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

    • setAfi

      public PerAfiSafiLocRibTlvBuilder setAfi(AddressFamily value)
      Set the property corresponding to BgpTableType.getAfi() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setCount

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

    • setSafi

      public PerAfiSafiLocRibTlvBuilder setSafi(SubsequentAddressFamily value)
      Set the property corresponding to BgpTableType.getSafi() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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