Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.mac.ip.adv.route

Class MacIpAdvRouteBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.mac.ip.adv.route.MacIpAdvRouteBuilder
@Generated("mdsal-binding-generator") public class MacIpAdvRouteBuilder extends Object
Class that builds MacIpAdvRoute 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: 

   
     MacIpAdvRoute createMacIpAdvRoute(int fooXyzzy, int barBaz) {
         return new MacIpAdvRouteBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MacIpAdvRouteBuilder

      public MacIpAdvRouteBuilder()
      Construct an empty builder.

    • MacIpAdvRouteBuilder

      public MacIpAdvRouteBuilder(Esi arg)
      Construct a new builder initialized from specified Esi.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.Esi from which the builder should be initialized

    • MacIpAdvRouteBuilder

      public MacIpAdvRouteBuilder(EthernetTagId arg)
      Construct a new builder initialized from specified EthernetTagId.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.EthernetTagId from which the builder should be initialized

    • MacIpAdvRouteBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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 MacIpAdvRoute empty()
      Get empty instance of MacIpAdvRoute.
      Returns:
      An empty MacIpAdvRoute

    • getEsi

      public Esi getEsi()
      Return current value associated with the property corresponding to Esi.getEsi().
      Returns:
      current value

    • getEthernetTagId

      public EthernetTagId getEthernetTagId()
      Return current value associated with the property corresponding to EthernetTagId.getEthernetTagId().
      Returns:
      current value

    • getIpAddress

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

    • getMacAddress

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getMacAddress()
      Return current value associated with the property corresponding to MacIpAdvRoute.getMacAddress().
      Returns:
      current value

    • getMplsLabel1

      public MplsLabel getMplsLabel1()
      Return current value associated with the property corresponding to MacIpAdvRoute.getMplsLabel1().
      Returns:
      current value

    • getMplsLabel2

      public MplsLabel getMplsLabel2()
      Return current value associated with the property corresponding to MacIpAdvRoute.getMplsLabel2().
      Returns:
      current value

    • augmentation

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

    • setEsi

      public MacIpAdvRouteBuilder setEsi(Esi value)
      Set the property corresponding to Esi.getEsi() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setEthernetTagId

      public MacIpAdvRouteBuilder setEthernetTagId(EthernetTagId value)
      Set the property corresponding to EthernetTagId.getEthernetTagId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIpAddress

      public MacIpAdvRouteBuilder setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
      Set the property corresponding to MacIpAdvRoute.getIpAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMacAddress

      public MacIpAdvRouteBuilder setMacAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
      Set the property corresponding to MacIpAdvRoute.getMacAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMplsLabel1

      public MacIpAdvRouteBuilder setMplsLabel1(MplsLabel value)
      Set the property corresponding to MacIpAdvRoute.getMplsLabel1() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMplsLabel2

      public MacIpAdvRouteBuilder setMplsLabel2(MplsLabel value)
      Set the property corresponding to MacIpAdvRoute.getMplsLabel2() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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