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

Class MapReplyBuilder

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

   
     MapReply createMapReply(int fooXyzzy, int barBaz) {
         return new MapReplyBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MapReplyBuilder

      public MapReplyBuilder()
      Construct an empty builder.

    • MapReplyBuilder

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

    • MapReplyBuilder

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

    • MapReplyBuilder

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

    • getEchoNonceEnabled

      public Boolean getEchoNonceEnabled()
      Return current value associated with the property corresponding to MapReply.getEchoNonceEnabled().
      Returns:
      current value

    • getMappingRecordItem

      public List<MappingRecordItem> getMappingRecordItem()
      Return current value associated with the property corresponding to MappingRecordList.getMappingRecordItem().
      Returns:
      current value

    • getNonce

      public Long getNonce()
      Return current value associated with the property corresponding to MapReply.getNonce().
      Returns:
      current value

    • getProbe

      public Boolean getProbe()
      Return current value associated with the property corresponding to MapReply.getProbe().
      Returns:
      current value

    • getSecurityEnabled

      public Boolean getSecurityEnabled()
      Return current value associated with the property corresponding to MapReply.getSecurityEnabled().
      Returns:
      current value

    • augmentation

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

    • setEchoNonceEnabled

      public MapReplyBuilder setEchoNonceEnabled(Boolean value)
      Set the property corresponding to MapReply.getEchoNonceEnabled() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMappingRecordItem

      public MapReplyBuilder setMappingRecordItem(List<MappingRecordItem> values)
      Set the property corresponding to MappingRecordList.getMappingRecordItem() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setNonce

      public MapReplyBuilder setNonce(Long value)
      Set the property corresponding to MapReply.getNonce() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setProbe

      public MapReplyBuilder setProbe(Boolean value)
      Set the property corresponding to MapReply.getProbe() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSecurityEnabled

      public MapReplyBuilder setSecurityEnabled(Boolean value)
      Set the property corresponding to MapReply.getSecurityEnabled() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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