Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720.sr.subobject.nai

Class UnnumberedAdjacencyBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720.sr.subobject.nai.UnnumberedAdjacencyBuilder
@Generated("mdsal-binding-generator") public class UnnumberedAdjacencyBuilder extends Object
Class that builds UnnumberedAdjacency 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: 

   
     UnnumberedAdjacency createUnnumberedAdjacency(int fooXyzzy, int barBaz) {
         return new UnnumberedAdjacencyBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • UnnumberedAdjacencyBuilder

      public UnnumberedAdjacencyBuilder()
      Construct an empty builder.

    • UnnumberedAdjacencyBuilder

      public UnnumberedAdjacencyBuilder(UnnumberedAdjacency base)
      Construct a builder initialized with state from specified UnnumberedAdjacency.
      Parameters:
      base - UnnumberedAdjacency from which the builder should be initialized

  • Method Details

    • getLocalInterfaceId

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

    • getLocalNodeId

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

    • getRemoteInterfaceId

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

    • getRemoteNodeId

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

    • augmentation

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

    • setLocalInterfaceId

      public UnnumberedAdjacencyBuilder setLocalInterfaceId(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to UnnumberedAdjacency.getLocalInterfaceId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLocalNodeId

      public UnnumberedAdjacencyBuilder setLocalNodeId(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to UnnumberedAdjacency.getLocalNodeId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRemoteInterfaceId

      public UnnumberedAdjacencyBuilder setRemoteInterfaceId(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to UnnumberedAdjacency.getRemoteInterfaceId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRemoteNodeId

      public UnnumberedAdjacencyBuilder setRemoteNodeId(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to UnnumberedAdjacency.getRemoteNodeId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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