Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev220720.edge

Class EdgeAttributesBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev220720.edge.EdgeAttributesBuilder
@Generated("mdsal-binding-generator") public class EdgeAttributesBuilder extends Object
Class that builds EdgeAttributes 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: 

   
     EdgeAttributes createEdgeAttributes(int fooXyzzy, int barBaz) {
         return new EdgeAttributesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • EdgeAttributesBuilder

      public EdgeAttributesBuilder()
      Construct an empty builder.

    • EdgeAttributesBuilder

      public EdgeAttributesBuilder(EdgeAttributes arg)
      Construct a new builder initialized from specified EdgeAttributes.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev220720.EdgeAttributes from which the builder should be initialized

    • EdgeAttributesBuilder

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

    • empty

      public static @NonNull EdgeAttributes empty()
      Get empty instance of EdgeAttributes.
      Returns:
      An empty EdgeAttributes

    • getAdjSid

      public org.opendaylight.yangtools.yang.common.Uint32 getAdjSid()
      Return current value associated with the property corresponding to EdgeAttributes.getAdjSid().
      Returns:
      current value

    • getAdjSid6

      public org.opendaylight.yangtools.yang.common.Uint32 getAdjSid6()
      Return current value associated with the property corresponding to EdgeAttributes.getAdjSid6().
      Returns:
      current value

    • getAdminGroup

      public org.opendaylight.yangtools.yang.common.Uint32 getAdminGroup()
      Return current value associated with the property corresponding to EdgeAttributes.getAdminGroup().
      Returns:
      current value

    • getAvailableBandwidth

      public DecimalBandwidth getAvailableBandwidth()
      Return current value associated with the property corresponding to EdgeAttributes.getAvailableBandwidth().
      Returns:
      current value

    • getBackupAdjSid

      public org.opendaylight.yangtools.yang.common.Uint32 getBackupAdjSid()
      Return current value associated with the property corresponding to EdgeAttributes.getBackupAdjSid().
      Returns:
      current value

    • getBackupAdjSid6

      public org.opendaylight.yangtools.yang.common.Uint32 getBackupAdjSid6()
      Return current value associated with the property corresponding to EdgeAttributes.getBackupAdjSid6().
      Returns:
      current value

    • getDelay

      public Delay getDelay()
      Return current value associated with the property corresponding to EdgeAttributes.getDelay().
      Returns:
      current value

    • getJitter

      public Delay getJitter()
      Return current value associated with the property corresponding to EdgeAttributes.getJitter().
      Returns:
      current value

    • getLocalAddress

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

    • getLocalAddress6

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

    • getLocalIdentifier

      public org.opendaylight.yangtools.yang.common.Uint32 getLocalIdentifier()
      Return current value associated with the property corresponding to EdgeAttributes.getLocalIdentifier().
      Returns:
      current value

    • getLoss

      public Loss getLoss()
      Return current value associated with the property corresponding to EdgeAttributes.getLoss().
      Returns:
      current value

    • getMaxLinkBandwidth

      public DecimalBandwidth getMaxLinkBandwidth()
      Return current value associated with the property corresponding to EdgeAttributes.getMaxLinkBandwidth().
      Returns:
      current value

    • getMaxResvLinkBandwidth

      public DecimalBandwidth getMaxResvLinkBandwidth()
      Return current value associated with the property corresponding to EdgeAttributes.getMaxResvLinkBandwidth().
      Returns:
      current value

    • getMetric

      public org.opendaylight.yangtools.yang.common.Uint32 getMetric()
      Return current value associated with the property corresponding to EdgeAttributes.getMetric().
      Returns:
      current value

    • getMinMaxDelay

      public MinMaxDelay getMinMaxDelay()
      Return current value associated with the property corresponding to EdgeAttributes.getMinMaxDelay().
      Returns:
      current value

    • getRemoteAddress

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

    • getRemoteAddress6

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

    • getRemoteIdentifier

      public org.opendaylight.yangtools.yang.common.Uint32 getRemoteIdentifier()
      Return current value associated with the property corresponding to EdgeAttributes.getRemoteIdentifier().
      Returns:
      current value

    • getResidualBandwidth

      public DecimalBandwidth getResidualBandwidth()
      Return current value associated with the property corresponding to EdgeAttributes.getResidualBandwidth().
      Returns:
      current value

    • getSrlgs

      public Set<org.opendaylight.yangtools.yang.common.Uint32> getSrlgs()
      Return current value associated with the property corresponding to EdgeAttributes.getSrlgs().
      Returns:
      current value

    • getTeMetric

      public org.opendaylight.yangtools.yang.common.Uint32 getTeMetric()
      Return current value associated with the property corresponding to EdgeAttributes.getTeMetric().
      Returns:
      current value

    • getUnreservedBandwidth

      public List<UnreservedBandwidth> getUnreservedBandwidth()
      Return current value associated with the property corresponding to EdgeAttributes.getUnreservedBandwidth().
      Returns:
      current value

    • getUtilizedBandwidth

      public DecimalBandwidth getUtilizedBandwidth()
      Return current value associated with the property corresponding to EdgeAttributes.getUtilizedBandwidth().
      Returns:
      current value

    • augmentation

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

    • setAdjSid

      public EdgeAttributesBuilder setAdjSid(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to EdgeAttributes.getAdjSid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setAdjSid6

      public EdgeAttributesBuilder setAdjSid6(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to EdgeAttributes.getAdjSid6() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setAdminGroup

      public EdgeAttributesBuilder setAdminGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to EdgeAttributes.getAdminGroup() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setAvailableBandwidth

      public EdgeAttributesBuilder setAvailableBandwidth(DecimalBandwidth value)
      Set the property corresponding to EdgeAttributes.getAvailableBandwidth() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setBackupAdjSid

      public EdgeAttributesBuilder setBackupAdjSid(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to EdgeAttributes.getBackupAdjSid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setBackupAdjSid6

      public EdgeAttributesBuilder setBackupAdjSid6(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to EdgeAttributes.getBackupAdjSid6() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setDelay

      public EdgeAttributesBuilder setDelay(Delay value)
      Set the property corresponding to EdgeAttributes.getDelay() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setJitter

      public EdgeAttributesBuilder setJitter(Delay value)
      Set the property corresponding to EdgeAttributes.getJitter() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLocalAddress

      public EdgeAttributesBuilder setLocalAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
      Set the property corresponding to EdgeAttributes.getLocalAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLocalAddress6

      public EdgeAttributesBuilder setLocalAddress6(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
      Set the property corresponding to EdgeAttributes.getLocalAddress6() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLocalIdentifier

      public EdgeAttributesBuilder setLocalIdentifier(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to EdgeAttributes.getLocalIdentifier() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLoss

      public EdgeAttributesBuilder setLoss(Loss value)
      Set the property corresponding to EdgeAttributes.getLoss() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMaxLinkBandwidth

      public EdgeAttributesBuilder setMaxLinkBandwidth(DecimalBandwidth value)
      Set the property corresponding to EdgeAttributes.getMaxLinkBandwidth() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMaxResvLinkBandwidth

      public EdgeAttributesBuilder setMaxResvLinkBandwidth(DecimalBandwidth value)
      Set the property corresponding to EdgeAttributes.getMaxResvLinkBandwidth() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMetric

      public EdgeAttributesBuilder setMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to EdgeAttributes.getMetric() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMinMaxDelay

      public EdgeAttributesBuilder setMinMaxDelay(MinMaxDelay value)
      Set the property corresponding to EdgeAttributes.getMinMaxDelay() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRemoteAddress

      public EdgeAttributesBuilder setRemoteAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
      Set the property corresponding to EdgeAttributes.getRemoteAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRemoteAddress6

      public EdgeAttributesBuilder setRemoteAddress6(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
      Set the property corresponding to EdgeAttributes.getRemoteAddress6() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRemoteIdentifier

      public EdgeAttributesBuilder setRemoteIdentifier(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to EdgeAttributes.getRemoteIdentifier() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setResidualBandwidth

      public EdgeAttributesBuilder setResidualBandwidth(DecimalBandwidth value)
      Set the property corresponding to EdgeAttributes.getResidualBandwidth() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSrlgs

      public EdgeAttributesBuilder setSrlgs(Set<org.opendaylight.yangtools.yang.common.Uint32> values)
      Set the property corresponding to EdgeAttributes.getSrlgs() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setTeMetric

      public EdgeAttributesBuilder setTeMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to EdgeAttributes.getTeMetric() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setUnreservedBandwidth

      public EdgeAttributesBuilder setUnreservedBandwidth(List<UnreservedBandwidth> values)
      Set the property corresponding to EdgeAttributes.getUnreservedBandwidth() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setUtilizedBandwidth

      public EdgeAttributesBuilder setUtilizedBandwidth(DecimalBandwidth value)
      Set the property corresponding to EdgeAttributes.getUtilizedBandwidth() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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