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

Class XtrReplyMappingBuilder

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

   
     XtrReplyMapping createXtrReplyMapping(int fooXyzzy, int barBaz) {
         return new XtrReplyMappingBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • XtrReplyMappingBuilder

      public XtrReplyMappingBuilder()
      Construct an empty builder.

    • XtrReplyMappingBuilder

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

    • XtrReplyMappingBuilder

      public XtrReplyMappingBuilder(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

    • XtrReplyMappingBuilder

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

    • getMapReply

      public MapReply getMapReply()
      Return current value associated with the property corresponding to MapReplyNotification.getMapReply().
      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<XtrReplyMapping>> 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

    • setMapReply

      public XtrReplyMappingBuilder setMapReply(MapReply value)
      Set the property corresponding to MapReplyNotification.getMapReply() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTransportAddress

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

    • addAugmentation

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