Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes

Class InterfaceBfdBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdBuilder
@Generated("mdsal-binding-generator") public class InterfaceBfdBuilder extends Object
Class that builds InterfaceBfd 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: 

   
     InterfaceBfd createInterfaceBfd(int fooXyzzy, int barBaz) {
         return new InterfaceBfdBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • InterfaceBfdBuilder

      public InterfaceBfdBuilder()
      Construct an empty builder.

    • InterfaceBfdBuilder

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

  • Method Details

    • key

      public InterfaceBfdKey key()
      Return current value associated with the property corresponding to InterfaceBfd.key().
      Returns:
      current value

    • getBfdKey

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

    • getBfdValue

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

    • augmentation

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

    • withKey

      public InterfaceBfdBuilder withKey(InterfaceBfdKey key)
      Set the key value corresponding to InterfaceBfd.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setBfdKey

      public InterfaceBfdBuilder setBfdKey(String value)
      Set the property corresponding to InterfaceBfd.getBfdKey() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setBfdValue

      public InterfaceBfdBuilder setBfdValue(String value)
      Set the property corresponding to InterfaceBfd.getBfdValue() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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