Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes

Class AggregatorBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.AggregatorBuilder
@Generated("mdsal-binding-generator") public class AggregatorBuilder extends Object
Class that builds Aggregator 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: 

   
     Aggregator createAggregator(int fooXyzzy, int barBaz) {
         return new AggregatorBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • AggregatorBuilder

      public AggregatorBuilder()
      Construct an empty builder.

    • AggregatorBuilder

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

    • AggregatorBuilder

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

    • getAsNumber

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getAsNumber()
      Return current value associated with the property corresponding to BgpAggregator.getAsNumber().
      Returns:
      current value

    • getNetworkAddress

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getNetworkAddress()
      Return current value associated with the property corresponding to BgpAggregator.getNetworkAddress().
      Returns:
      current value

    • augmentation

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

    • setAsNumber

      public AggregatorBuilder setAsNumber(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
      Set the property corresponding to BgpAggregator.getAsNumber() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNetworkAddress

      public AggregatorBuilder setNetworkAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
      Set the property corresponding to BgpAggregator.getNetworkAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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