Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.attribute

Class SrLanAdjIdsBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.attribute.SrLanAdjIdsBuilder
@Generated("mdsal-binding-generator") public class SrLanAdjIdsBuilder extends Object
Class that builds SrLanAdjIds 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: 

   
     SrLanAdjIds createSrLanAdjIds(int fooXyzzy, int barBaz) {
         return new SrLanAdjIdsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SrLanAdjIdsBuilder

      public SrLanAdjIdsBuilder()
      Construct an empty builder.

    • SrLanAdjIdsBuilder

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

    • SrLanAdjIdsBuilder

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

    • SrLanAdjIdsBuilder

      public SrLanAdjIdsBuilder(SidLabelIndex arg)
      Construct a new builder initialized from specified SidLabelIndex.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev200120.SidLabelIndex from which the builder should be initialized

    • SrLanAdjIdsBuilder

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

    • getFlags

      public Flags getFlags()
      Return current value associated with the property corresponding to AdjFlags.getFlags().
      Returns:
      current value

    • getIsoSystemId

      public IsoSystemIdentifier getIsoSystemId()
      Return current value associated with the property corresponding to LanAdjSidTlv.getIsoSystemId().
      Returns:
      current value

    • getNeighborId

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

    • getSidLabelIndex

      public SidLabelIndex getSidLabelIndex()
      Return current value associated with the property corresponding to SidLabelIndex.getSidLabelIndex().
      Returns:
      current value

    • getWeight

      public Weight getWeight()
      Return current value associated with the property corresponding to LanAdjSidTlv.getWeight().
      Returns:
      current value

    • augmentation

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

    • setFlags

      public SrLanAdjIdsBuilder setFlags(Flags value)
      Set the property corresponding to AdjFlags.getFlags() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIsoSystemId

      public SrLanAdjIdsBuilder setIsoSystemId(IsoSystemIdentifier value)
      Set the property corresponding to LanAdjSidTlv.getIsoSystemId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNeighborId

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

    • setSidLabelIndex

      public SrLanAdjIdsBuilder setSidLabelIndex(SidLabelIndex value)
      Set the property corresponding to SidLabelIndex.getSidLabelIndex() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setWeight

      public SrLanAdjIdsBuilder setWeight(Weight value)
      Set the property corresponding to LanAdjSidTlv.getWeight() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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