Class PeerUpNotificationBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<PeerUpNotification>, org.opendaylight.yangtools.concepts.CheckedBuilder<PeerUpNotification,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    @Generated("mdsal-binding-generator")
    public class PeerUpNotificationBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<PeerUpNotification>
    Class that builds PeerUpNotification 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:

       
         PeerUpNotification createPeerUpNotification(int fooXyzzy, int barBaz) {
             return new PeerUpNotificationBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

    This pattern is supported by the immutable nature of PeerUpNotification, 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:
    PeerUpNotification, Builder
    • Constructor Detail

      • PeerUpNotificationBuilder

        public PeerUpNotificationBuilder()
      • PeerUpNotificationBuilder

        public PeerUpNotificationBuilder​(PeerHeader arg)
      • PeerUpNotificationBuilder

        public PeerUpNotificationBuilder​(PeerUp arg)
      • PeerUpNotificationBuilder

        public PeerUpNotificationBuilder​(PeerUpNotification base)
    • Method Detail

      • 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:
        • PeerUp
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.PeerHeader
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getLocalAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getLocalAddress()
      • getLocalPort

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getLocalPort()
      • getPeerHeader

        public PeerHeader getPeerHeader()
      • getRemotePort

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getRemotePort()
      • getSentOpen

        public SentOpen getSentOpen()
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerUpNotification>> E$$ augmentation​(Class<E$$> augmentationType)
      • setLocalAddress

        public PeerUpNotificationBuilder setLocalAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
      • setLocalPort

        public PeerUpNotificationBuilder setLocalPort​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
      • setRemotePort

        public PeerUpNotificationBuilder setRemotePort​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
      • addAugmentation

        public PeerUpNotificationBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<PeerUpNotification> 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 PeerUpNotificationBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerUpNotification>> 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