Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105

Class AddMappingBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.AddMappingBuilder
@Generated("mdsal-binding-generator") public class AddMappingBuilder extends Object
Class that builds AddMapping 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: 

   
     AddMapping createAddMapping(int fooXyzzy, int barBaz) {
         return new AddMappingBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • AddMappingBuilder

      public AddMappingBuilder()
      Construct an empty builder.

    • AddMappingBuilder

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

    • AddMappingBuilder

      public AddMappingBuilder(TransportAddress arg)
      Construct a new builder initialized from specified TransportAddress.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.TransportAddress from which the builder should be initialized

    • AddMappingBuilder

      public AddMappingBuilder(AddMapping base)
      Construct a builder initialized with state from specified AddMapping.
      Parameters:
      base - AddMapping 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

    • getMapRegister

      public MapRegister getMapRegister()
      Return current value associated with the property corresponding to MapRegisterNotification.getMapRegister().
      Returns:
      current value

    • getTransportAddress

      public TransportAddress getTransportAddress()
      Return current value associated with the property corresponding to TransportAddress.getTransportAddress().
      Returns:
      current value

    • augmentation

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

    • setMapRegister

      public AddMappingBuilder setMapRegister(MapRegister value)
      Set the property corresponding to MapRegisterNotification.getMapRegister() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTransportAddress

      public AddMappingBuilder setTransportAddress(TransportAddress value)
      Set the property corresponding to TransportAddress.getTransportAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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