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

Class PeerBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.peers.PeerBuilder
@Generated("mdsal-binding-generator") public class PeerBuilder extends Object
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 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.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

    • key

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

    • 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

    • 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

    • getMirrors

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

    • getPeerDistinguisher

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

    • getPeerId

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

    • getPeerSession

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

    • getPostPolicyRib

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

    • getPrePolicyRib

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

    • getRouterDistinguisher

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

    • getStats

      public Stats getStats()
      Return current value associated with the property corresponding to Peer.getStats().
      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<Peer>> 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 PeerBuilder withKey(PeerKey key)
      Set the key value corresponding to Peer.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

    • addAugmentation

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