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

Class LocatorRecordBuilder

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

   
     LocatorRecord createLocatorRecord(int fooXyzzy, int barBaz) {
         return new LocatorRecordBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • LocatorRecordBuilder

      public LocatorRecordBuilder()
      Construct an empty builder.

    • LocatorRecordBuilder

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

    • LocatorRecordBuilder

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

    • key

      public LocatorRecordKey key()
      Return current value associated with the property corresponding to LocatorRecord.key().
      Returns:
      current value

    • getLocalLocator

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

    • getLocatorId

      public String getLocatorId()
      Return current value associated with the property corresponding to LocatorRecord.getLocatorId().
      Returns:
      current value

    • getMulticastPriority

      public org.opendaylight.yangtools.yang.common.Uint8 getMulticastPriority()
      Return current value associated with the property corresponding to LocatorRecord.getMulticastPriority().
      Returns:
      current value

    • getMulticastWeight

      public org.opendaylight.yangtools.yang.common.Uint8 getMulticastWeight()
      Return current value associated with the property corresponding to LocatorRecord.getMulticastWeight().
      Returns:
      current value

    • getPriority

      public org.opendaylight.yangtools.yang.common.Uint8 getPriority()
      Return current value associated with the property corresponding to LocatorRecord.getPriority().
      Returns:
      current value

    • getRloc

      public Rloc getRloc()
      Return current value associated with the property corresponding to RlocContainer.getRloc().
      Returns:
      current value

    • getRlocProbed

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

    • getRouted

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

    • getWeight

      public org.opendaylight.yangtools.yang.common.Uint8 getWeight()
      Return current value associated with the property corresponding to LocatorRecord.getWeight().
      Returns:
      current value

    • augmentation

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

    • withKey

      public LocatorRecordBuilder withKey(LocatorRecordKey key)
      Set the key value corresponding to LocatorRecord.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setLocalLocator

      public LocatorRecordBuilder setLocalLocator(Boolean value)
      Set the property corresponding to LocatorRecord.getLocalLocator() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLocatorId

      public LocatorRecordBuilder setLocatorId(String value)
      Set the property corresponding to LocatorRecord.getLocatorId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMulticastPriority

      public LocatorRecordBuilder setMulticastPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to LocatorRecord.getMulticastPriority() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMulticastWeight

      public LocatorRecordBuilder setMulticastWeight(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to LocatorRecord.getMulticastWeight() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPriority

      public LocatorRecordBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to LocatorRecord.getPriority() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRloc

      public LocatorRecordBuilder setRloc(Rloc value)
      Set the property corresponding to RlocContainer.getRloc() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRlocProbed

      public LocatorRecordBuilder setRlocProbed(Boolean value)
      Set the property corresponding to LocatorRecord.getRlocProbed() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRouted

      public LocatorRecordBuilder setRouted(Boolean value)
      Set the property corresponding to LocatorRecord.getRouted() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setWeight

      public LocatorRecordBuilder setWeight(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to LocatorRecord.getWeight() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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