Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.ted.rev131021.srlg.attributes._interface.switching.capabilities

Class MaxLspBandwidthBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.ted.rev131021.srlg.attributes._interface.switching.capabilities.MaxLspBandwidthBuilder
@Generated("mdsal-binding-generator") public class MaxLspBandwidthBuilder extends Object
Class that builds MaxLspBandwidth 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: 

   
     MaxLspBandwidth createMaxLspBandwidth(int fooXyzzy, int barBaz) {
         return new MaxLspBandwidthBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MaxLspBandwidthBuilder

      public MaxLspBandwidthBuilder()
      Construct an empty builder.

    • MaxLspBandwidthBuilder

      public MaxLspBandwidthBuilder(MaxLspBandwidth base)
      Construct a builder initialized with state from specified MaxLspBandwidth.
      Parameters:
      base - MaxLspBandwidth from which the builder should be initialized

  • Method Details

    • key

      public MaxLspBandwidthKey key()
      Return current value associated with the property corresponding to MaxLspBandwidth.key().
      Returns:
      current value

    • getBandwidth

      public org.opendaylight.yangtools.yang.common.Decimal64 getBandwidth()
      Return current value associated with the property corresponding to MaxLspBandwidth.getBandwidth().
      Returns:
      current value

    • getPriority

      public org.opendaylight.yangtools.yang.common.Uint8 getPriority()
      Return current value associated with the property corresponding to MaxLspBandwidth.getPriority().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MaxLspBandwidth>> 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 MaxLspBandwidthBuilder withKey(MaxLspBandwidthKey key)
      Set the key value corresponding to MaxLspBandwidth.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setBandwidth

      public MaxLspBandwidthBuilder setBandwidth(org.opendaylight.yangtools.yang.common.Decimal64 value)
      Set the property corresponding to MaxLspBandwidth.getBandwidth() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPriority

      public MaxLspBandwidthBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to MaxLspBandwidth.getPriority() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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