Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.peer.up

Class ReceivedOpenBuilder

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

   
     ReceivedOpen createReceivedOpen(int fooXyzzy, int barBaz) {
         return new ReceivedOpenBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ReceivedOpenBuilder

      public ReceivedOpenBuilder()
      Construct an empty builder.

    • ReceivedOpenBuilder

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

    • ReceivedOpenBuilder

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

    • ReceivedOpenBuilder

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

    • empty

      public static @NonNull ReceivedOpen empty()
      Get empty instance of ReceivedOpen.
      Returns:
      An empty ReceivedOpen

    • 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<ReceivedOpen>> 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 ReceivedOpenBuilder 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 ReceivedOpenBuilder setBgpParameters(List<BgpParameters> values)
      Set the property corresponding to OpenMessage.getBgpParameters() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setHoldTimer

      public ReceivedOpenBuilder 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 ReceivedOpenBuilder 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 ReceivedOpenBuilder setVersion(ProtocolVersion value)
      Set the property corresponding to OpenMessage.getVersion() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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