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

Class PeerHeaderBuilder

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

   
     PeerHeader createPeerHeader(int fooXyzzy, int barBaz) {
         return new PeerHeaderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PeerHeaderBuilder

      public PeerHeaderBuilder()
      Construct an empty builder.

    • PeerHeaderBuilder

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

    • PeerHeaderBuilder

      public PeerHeaderBuilder(Timestamp arg)
      Construct a new builder initialized from specified Timestamp.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.Timestamp from which the builder should be initialized

    • PeerHeaderBuilder

      public PeerHeaderBuilder(PeerHeader base)
      Construct a builder initialized with state from specified PeerHeader.
      Parameters:
      base - PeerHeader 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 PeerHeader empty()
      Get empty instance of PeerHeader.
      Returns:
      An empty PeerHeader

    • getAddress

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

    • getAdjRibInType

      public AdjRibInType getAdjRibInType()
      Return current value associated with the property corresponding to PeerHeader.getAdjRibInType().
      Returns:
      current value

    • getAs

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

    • getBgpId

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

    • getIpv4

      public Boolean getIpv4()
      Return current value associated with the property corresponding to PeerHeader.getIpv4().
      Returns:
      current value

    • getPeerDistinguisher

      public Peer.PeerDistinguisher getPeerDistinguisher()
      Return current value associated with the property corresponding to Peer.getPeerDistinguisher().
      Returns:
      current value

    • getTimestampMicro

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

    • getTimestampSec

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

    • getType

      public PeerType getType()
      Return current value associated with the property corresponding to Peer.getType().
      Returns:
      current value

    • augmentation

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

    • setAddress

      public PeerHeaderBuilder setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
      Set the property corresponding to Peer.getAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setAdjRibInType

      public PeerHeaderBuilder setAdjRibInType(AdjRibInType value)
      Set the property corresponding to PeerHeader.getAdjRibInType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setAs

      public PeerHeaderBuilder setAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
      Set the property corresponding to Peer.getAs() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setBgpId

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

    • setIpv4

      public PeerHeaderBuilder setIpv4(Boolean value)
      Set the property corresponding to PeerHeader.getIpv4() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPeerDistinguisher

      public PeerHeaderBuilder setPeerDistinguisher(Peer.PeerDistinguisher value)
      Set the property corresponding to Peer.getPeerDistinguisher() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTimestampMicro

      public PeerHeaderBuilder setTimestampMicro(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
      Set the property corresponding to Timestamp.getTimestampMicro() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTimestampSec

      public PeerHeaderBuilder setTimestampSec(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
      Set the property corresponding to Timestamp.getTimestampSec() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setType

      public PeerHeaderBuilder setType(PeerType value)
      Set the property corresponding to Peer.getType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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