Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.local.routing.rev151009.local.routes.top

Class LocalRoutesBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.local.routing.rev151009.local.routes.top.LocalRoutesBuilder
@Generated("mdsal-binding-generator") public class LocalRoutesBuilder extends Object
Class that builds LocalRoutes 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: 

   
     LocalRoutes createLocalRoutes(int fooXyzzy, int barBaz) {
         return new LocalRoutesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • LocalRoutesBuilder

      public LocalRoutesBuilder()
      Construct an empty builder.

    • LocalRoutesBuilder

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

    • LocalRoutesBuilder

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

    • LocalRoutesBuilder

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

    • getConfig

      public Config getConfig()
      Return current value associated with the property corresponding to LocalRoutes.getConfig().
      Returns:
      current value

    • getLocalAggregates

      public LocalAggregates getLocalAggregates()
      Return current value associated with the property corresponding to LocalAggregateTop.getLocalAggregates().
      Returns:
      current value

    • getState

      public State getState()
      Return current value associated with the property corresponding to LocalRoutes.getState().
      Returns:
      current value

    • getStaticRoutes

      public StaticRoutes getStaticRoutes()
      Return current value associated with the property corresponding to LocalStaticTop.getStaticRoutes().
      Returns:
      current value

    • augmentation

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

    • setConfig

      public LocalRoutesBuilder setConfig(Config value)
      Set the property corresponding to LocalRoutes.getConfig() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLocalAggregates

      public LocalRoutesBuilder setLocalAggregates(LocalAggregates value)
      Set the property corresponding to LocalAggregateTop.getLocalAggregates() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setState

      public LocalRoutesBuilder setState(State value)
      Set the property corresponding to LocalRoutes.getState() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setStaticRoutes

      public LocalRoutesBuilder setStaticRoutes(StaticRoutes value)
      Set the property corresponding to LocalStaticTop.getStaticRoutes() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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