Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.peers

Class PeerBuilder

java.lang.Object
org.opendaylight.yangtools.binding.lib.AugmentableBuilder<Peer,PeerBuilder>
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.peers.PeerBuilder
All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Mutable
@Generated("mdsal-binding-generator") public class PeerBuilder extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<Peer,PeerBuilder>
Class that builds Peer 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: 

   
     Peer createPeer(int fooXyzzy, int barBaz) {
         return new PeerBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    Constructors
    Constructor
    Description
    PeerBuilder()
    Construct an empty builder.
    PeerBuilder(Peer arg)
    Construct a new builder initialized from specified Peer.
    PeerBuilder(Peer base)
    Construct a builder initialized with state from specified Peer.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull Peer
    build()
    Returns A new Peer instance.
    void
    fieldsFrom(org.opendaylight.yangtools.binding.Grouping arg)
    Set fields from given grouping argument.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
    getAddress()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not be generated in a future release
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
    getAs()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not be generated in a future release
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
    getBgpId()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not be generated in a future release
    Mirrors
    getMirrors()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not be generated in a future release
    Peer.PeerDistinguisher
    getPeerDistinguisher()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not be generated in a future release
    PeerId
    getPeerId()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not be generated in a future release
    PeerSession
    getPeerSession()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not be generated in a future release
    PostPolicyRib
    getPostPolicyRib()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not be generated in a future release
    PrePolicyRib
    getPrePolicyRib()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not be generated in a future release
    String
    getRouterDistinguisher()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not be generated in a future release
    Stats
    getStats()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not be generated in a future release
    PeerType
    getType()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not be generated in a future release
    PeerKey
    key()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not be generated in a future release
    PeerBuilder
    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.
    PeerBuilder
    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.
    PeerBuilder
    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.
    PeerBuilder
    setMirrors(Mirrors value)
    Set the property corresponding to Peer.getMirrors() to the specified value.
    PeerBuilder
    setPeerDistinguisher(Peer.PeerDistinguisher value)
    Set the property corresponding to Peer.getPeerDistinguisher() to the specified value.
    PeerBuilder
    setPeerId(PeerId value)
    Set the property corresponding to Peer.getPeerId() to the specified value.
    PeerBuilder
    setPeerSession(PeerSession value)
    Set the property corresponding to Peer.getPeerSession() to the specified value.
    PeerBuilder
    setPostPolicyRib(PostPolicyRib value)
    Set the property corresponding to Peer.getPostPolicyRib() to the specified value.
    PeerBuilder
    setPrePolicyRib(PrePolicyRib value)
    Set the property corresponding to Peer.getPrePolicyRib() to the specified value.
    PeerBuilder
    setRouterDistinguisher(String value)
    Set the property corresponding to Peer.getRouterDistinguisher() to the specified value.
    PeerBuilder
    setStats(Stats value)
    Set the property corresponding to Peer.getStats() to the specified value.
    PeerBuilder
    setType(PeerType value)
    Set the property corresponding to Peer.getType() to the specified value.
    PeerBuilder
    withKey(PeerKey key)
    Set the key value corresponding to EntryObject.key() to the specified value.

    Methods inherited from class org.opendaylight.yangtools.binding.lib.AugmentableBuilder

    addAugmentation, augmentation, augmentations, removeAugmentation

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PeerBuilder

      public PeerBuilder()
      Construct an empty builder.

    • PeerBuilder

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

    • PeerBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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

    • key

      @Deprecated(forRemoval=true) public PeerKey key()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to EntryObject.key().
      Returns:
      current value

    • getAddress

      @Deprecated(forRemoval=true) public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getAddress()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to Peer.getAddress().
      Returns:
      current value

    • getAs

      @Deprecated(forRemoval=true) public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getAs()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to Peer.getAs().
      Returns:
      current value

    • getBgpId

      @Deprecated(forRemoval=true) public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getBgpId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to Peer.getBgpId().
      Returns:
      current value

    • getMirrors

      @Deprecated(forRemoval=true) public Mirrors getMirrors()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to Peer.getMirrors().
      Returns:
      current value

    • getPeerDistinguisher

      @Deprecated(forRemoval=true) public Peer.PeerDistinguisher getPeerDistinguisher()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to Peer.getPeerDistinguisher().
      Returns:
      current value

    • getPeerId

      @Deprecated(forRemoval=true) public PeerId getPeerId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to Peer.getPeerId().
      Returns:
      current value

    • getPeerSession

      @Deprecated(forRemoval=true) public PeerSession getPeerSession()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to Peer.getPeerSession().
      Returns:
      current value

    • getPostPolicyRib

      @Deprecated(forRemoval=true) public PostPolicyRib getPostPolicyRib()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to Peer.getPostPolicyRib().
      Returns:
      current value

    • getPrePolicyRib

      @Deprecated(forRemoval=true) public PrePolicyRib getPrePolicyRib()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to Peer.getPrePolicyRib().
      Returns:
      current value

    • getRouterDistinguisher

      @Deprecated(forRemoval=true) public String getRouterDistinguisher()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to Peer.getRouterDistinguisher().
      Returns:
      current value

    • getStats

      @Deprecated(forRemoval=true) public Stats getStats()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to Peer.getStats().
      Returns:
      current value

    • getType

      @Deprecated(forRemoval=true) public PeerType getType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to Peer.getType().
      Returns:
      current value

    • withKey

      public PeerBuilder withKey(PeerKey key)
      Set the key value corresponding to EntryObject.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setAddress

      public PeerBuilder 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

    • setAs

      public PeerBuilder 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 PeerBuilder 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

    • setMirrors

      public PeerBuilder setMirrors(Mirrors value)
      Set the property corresponding to Peer.getMirrors() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPeerDistinguisher

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

    • setPeerId

      public PeerBuilder setPeerId(PeerId value)
      Set the property corresponding to Peer.getPeerId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPeerSession

      public PeerBuilder setPeerSession(PeerSession value)
      Set the property corresponding to Peer.getPeerSession() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPostPolicyRib

      public PeerBuilder setPostPolicyRib(PostPolicyRib value)
      Set the property corresponding to Peer.getPostPolicyRib() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPrePolicyRib

      public PeerBuilder setPrePolicyRib(PrePolicyRib value)
      Set the property corresponding to Peer.getPrePolicyRib() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRouterDistinguisher

      public PeerBuilder setRouterDistinguisher(String value)
      Set the property corresponding to Peer.getRouterDistinguisher() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setStats

      public PeerBuilder setStats(Stats value)
      Set the property corresponding to Peer.getStats() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setType

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

    • build

      public @NonNull Peer build()
      Returns A new Peer instance.
      Returns:
      A new Peer instance