Package org.opendaylight.yang.gen.v1.urn.opendaylight.module.config.rev141015

Class SetConfigInputBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.module.config.rev141015.SetConfigInputBuilder
@Generated("mdsal-binding-generator") public class SetConfigInputBuilder extends Object
Class that builds SetConfigInput 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: 

   
     SetConfigInput createSetConfigInput(int fooXyzzy, int barBaz) {
         return new SetConfigInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SetConfigInputBuilder

      public SetConfigInputBuilder()
      Construct an empty builder.

    • SetConfigInputBuilder

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

    • SetConfigInputBuilder

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

    • SetConfigInputBuilder

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

    • SetConfigInputBuilder

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

    • getFlag

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

    • getMissSearchLength

      public org.opendaylight.yangtools.yang.common.Uint16 getMissSearchLength()
      Return current value associated with the property corresponding to NodeConfig.getMissSearchLength().
      Returns:
      current value

    • getNode

      public NodeRef getNode()
      Return current value associated with the property corresponding to NodeContextRef.getNode().
      Returns:
      current value

    • getTransactionId

      public TransactionId getTransactionId()
      Return current value associated with the property corresponding to TransactionAware.getTransactionId().
      Returns:
      current value

    • augmentation

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

    • setFlag

      public SetConfigInputBuilder setFlag(String value)
      Set the property corresponding to NodeConfig.getFlag() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMissSearchLength

      public SetConfigInputBuilder setMissSearchLength(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to NodeConfig.getMissSearchLength() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNode

      public SetConfigInputBuilder setNode(NodeRef value)
      Set the property corresponding to NodeContextRef.getNode() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTransactionId

      public SetConfigInputBuilder setTransactionId(TransactionId value)
      Set the property corresponding to TransactionAware.getTransactionId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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