Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.redirect.as4.extended.community

Class RedirectAs4Builder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.redirect.as4.extended.community.RedirectAs4Builder
@Generated("mdsal-binding-generator") public class RedirectAs4Builder extends Object
Class that builds RedirectAs4 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: 

   
     RedirectAs4 createRedirectAs4(int fooXyzzy, int barBaz) {
         return new RedirectAs4Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • RedirectAs4Builder

      public RedirectAs4Builder()
      Construct an empty builder.

    • RedirectAs4Builder

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

  • Method Details

    • empty

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

    • getGlobalAdministrator

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

    • getLocalAdministrator

      public org.opendaylight.yangtools.yang.common.Uint16 getLocalAdministrator()
      Return current value associated with the property corresponding to RedirectAs4.getLocalAdministrator().
      Returns:
      current value

    • augmentation

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

    • setGlobalAdministrator

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

    • setLocalAdministrator

      public RedirectAs4Builder setLocalAdministrator(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to RedirectAs4.getLocalAdministrator() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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