Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120

Class TriggerSyncInputBuilder

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

   
     TriggerSyncInput createTriggerSyncInput(int fooXyzzy, int barBaz) {
         return new TriggerSyncInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • TriggerSyncInputBuilder

      public TriggerSyncInputBuilder()
      Construct an empty builder.

    • TriggerSyncInputBuilder

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

    • TriggerSyncInputBuilder

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

    • TriggerSyncInputBuilder

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

    • TriggerSyncInputBuilder

      public TriggerSyncInputBuilder(NodeId arg)
      Construct a new builder initialized from specified NodeId.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.NodeId from which the builder should be initialized

    • TriggerSyncInputBuilder

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

    • getName

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

    • getNetworkTopologyRef

      public NetworkTopologyRef getNetworkTopologyRef()
      Return current value associated with the property corresponding to NetworkTopologyReference.getNetworkTopologyRef().
      Returns:
      current value

    • getNode

      public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId getNode()
      Return current value associated with the property corresponding to NodeId.getNode().
      Returns:
      current value

    • augmentation

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

    • setName

      public TriggerSyncInputBuilder setName(String value)
      Set the property corresponding to LspId.getName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNetworkTopologyRef

      public TriggerSyncInputBuilder setNetworkTopologyRef(NetworkTopologyRef value)
      Set the property corresponding to NetworkTopologyReference.getNetworkTopologyRef() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNode

      public TriggerSyncInputBuilder setNode(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
      Set the property corresponding to NodeId.getNode() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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