java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev200120.AddPrefixInputBuilder

@Generated("mdsal-binding-generator") public class AddPrefixInputBuilder extends Object
Class that builds AddPrefixInput 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:

   
     AddPrefixInput createAddPrefixInput(int fooXyzzy, int barBaz) {
         return new AddPrefixInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • AddPrefixInputBuilder

      public AddPrefixInputBuilder()
      Construct an empty builder.
    • AddPrefixInputBuilder

      public AddPrefixInputBuilder(Input arg)
      Construct a new builder initialized from specified Input.
      Parameters:
      arg - Input from which the builder should be initialized
    • AddPrefixInputBuilder

      public AddPrefixInputBuilder(AddPrefixInput base)
      Construct a builder initialized with state from specified AddPrefixInput.
      Parameters:
      base - AddPrefixInput 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
    • getBatchsize

      public org.opendaylight.yangtools.yang.common.Uint32 getBatchsize()
      Return current value associated with the property corresponding to Input.getBatchsize().
      Returns:
      current value
    • getCount

      public org.opendaylight.yangtools.yang.common.Uint32 getCount()
      Return current value associated with the property corresponding to Input.getCount().
      Returns:
      current value
    • getNexthop

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

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix getPrefix()
      Return current value associated with the property corresponding to Input.getPrefix().
      Returns:
      current value
    • augmentation

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

      public AddPrefixInputBuilder setBatchsize(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Input.getBatchsize() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setCount

      public AddPrefixInputBuilder setCount(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Input.getCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setNexthop

      public AddPrefixInputBuilder setNexthop(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
      Set the property corresponding to AddPrefixInput.getNexthop() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setPrefix

      public AddPrefixInputBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value)
      Set the property corresponding to Input.getPrefix() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

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