Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.route.target.ipv4.grouping

Class RouteTargetIpv4Builder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.route.target.ipv4.grouping.RouteTargetIpv4Builder
@Generated("mdsal-binding-generator") public class RouteTargetIpv4Builder extends Object
Class that builds RouteTargetIpv4 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: 

   
     RouteTargetIpv4 createRouteTargetIpv4(int fooXyzzy, int barBaz) {
         return new RouteTargetIpv4Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • RouteTargetIpv4Builder

      public RouteTargetIpv4Builder()
      Construct an empty builder.

    • RouteTargetIpv4Builder

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

    • RouteTargetIpv4Builder

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

    • RouteTargetIpv4Builder

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

    • getGlobalAdministrator

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

    • getLocalAdministrator

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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetIpv4>> 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 RouteTargetIpv4Builder setGlobalAdministrator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
      Set the property corresponding to RouteIpv4ExtendedCommunity.getGlobalAdministrator() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLocalAdministrator

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

    • addAugmentation

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