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

Class RoutingPolicyBuilder

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

   
     RoutingPolicy createRoutingPolicy(int fooXyzzy, int barBaz) {
         return new RoutingPolicyBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • RoutingPolicyBuilder

      public RoutingPolicyBuilder()
      Construct an empty builder.

    • RoutingPolicyBuilder

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

  • Method Details

    • empty

      public static @NonNull RoutingPolicy empty()
      Get empty instance of RoutingPolicy.
      Returns:
      An empty RoutingPolicy

    • getDefinedSets

      public DefinedSets getDefinedSets()
      Return current value associated with the property corresponding to RoutingPolicy.getDefinedSets().
      Returns:
      current value

    • getPolicyDefinitions

      public PolicyDefinitions getPolicyDefinitions()
      Return current value associated with the property corresponding to RoutingPolicy.getPolicyDefinitions().
      Returns:
      current value

    • augmentation

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

    • setDefinedSets

      public RoutingPolicyBuilder setDefinedSets(DefinedSets value)
      Set the property corresponding to RoutingPolicy.getDefinedSets() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPolicyDefinitions

      public RoutingPolicyBuilder setPolicyDefinitions(PolicyDefinitions value)
      Set the property corresponding to RoutingPolicy.getPolicyDefinitions() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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