Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.afi.safi.route.counter

Class AfiSafiBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.afi.safi.route.counter.AfiSafiBuilder
@Generated("mdsal-binding-generator") public class AfiSafiBuilder extends Object
Class that builds AfiSafi 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: 

   
     AfiSafi createAfiSafi(int fooXyzzy, int barBaz) {
         return new AfiSafiBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • AfiSafiBuilder

      public AfiSafiBuilder()
      Construct an empty builder.

    • AfiSafiBuilder

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

    • AfiSafiBuilder

      public AfiSafiBuilder(AfiSafi base)
      Construct a builder initialized with state from specified AfiSafi.
      Parameters:
      base - AfiSafi 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 AfiSafiKey key()
      Return current value associated with the property corresponding to AfiSafi.key().
      Returns:
      current value

    • 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 AfiSafi.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<AfiSafi>> 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 AfiSafiBuilder withKey(AfiSafiKey key)
      Set the key value corresponding to AfiSafi.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setAfi

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

    • setCount

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

    • setSafi

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

    • addAugmentation

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