Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120

Class OpenBuilder

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

   
     Open createOpen(int fooXyzzy, int barBaz) {
         return new OpenBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • OpenBuilder

      public OpenBuilder()
      Construct an empty builder.

    • OpenBuilder

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

    • OpenBuilder

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

    • getBgpIdentifier

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

    • getBgpParameters

      public List<BgpParameters> getBgpParameters()
      Return current value associated with the property corresponding to OpenMessage.getBgpParameters().
      Returns:
      current value

    • getHoldTimer

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

    • getMyAsNumber

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

    • getVersion

      public ProtocolVersion getVersion()
      Return current value associated with the property corresponding to OpenMessage.getVersion().
      Returns:
      current value

    • augmentation

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

    • setBgpIdentifier

      public OpenBuilder setBgpIdentifier(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
      Set the property corresponding to OpenMessage.getBgpIdentifier() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setBgpParameters

      public OpenBuilder setBgpParameters(List<BgpParameters> values)
      Set the property corresponding to OpenMessage.getBgpParameters() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setHoldTimer

      public OpenBuilder setHoldTimer(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to OpenMessage.getHoldTimer() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMyAsNumber

      public OpenBuilder setMyAsNumber(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to OpenMessage.getMyAsNumber() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setVersion

      public OpenBuilder setVersion(ProtocolVersion value)
      Set the property corresponding to OpenMessage.getVersion() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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