Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family.ipv4._case

Class Ipv4Builder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family.ipv4._case.Ipv4Builder
@Generated("mdsal-binding-generator") public class Ipv4Builder extends Object
Class that builds Ipv4 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: 

   
     Ipv4 createIpv4(int fooXyzzy, int barBaz) {
         return new Ipv4Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Ipv4Builder

      public Ipv4Builder()
      Construct an empty builder.

    • Ipv4Builder

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

    • Ipv4Builder

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

    • getDestinationIpv4Address

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

    • getSourceIpv4Address

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

    • augmentation

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

    • setDestinationIpv4Address

      public Ipv4Builder setDestinationIpv4Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
      Set the property corresponding to Ipv4.getDestinationIpv4Address() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSourceIpv4Address

      public Ipv4Builder setSourceIpv4Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
      Set the property corresponding to EndpointsIpv4Source.getSourceIpv4Address() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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