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

Class SentOpenBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<SentOpen>, org.opendaylight.yangtools.concepts.CheckedBuilder<SentOpen,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class SentOpenBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<SentOpen>
    Class that builds SentOpenBuilder 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: 

       
     SentOpenBuilder createTarget(int fooXyzzy, int barBaz) {
         return new SentOpenBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

    This pattern is supported by the immutable nature of SentOpenBuilder, 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 oportunities, 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:
    SentOpenBuilder, Builder

    • Constructor Detail

      • SentOpenBuilder

        public SentOpenBuilder()

      • SentOpenBuilder

        public SentOpenBuilder​(OpenMsg arg)

      • SentOpenBuilder

        public SentOpenBuilder​(OpenMessage arg)

      • SentOpenBuilder

        public SentOpenBuilder​(SentOpen 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:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.OpenMsg
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.OpenMessage
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getBgpIdentifier

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getBgpIdentifier()

      • getHoldTimer

        public org.opendaylight.yangtools.yang.common.Uint16 getHoldTimer()

      • getMyAsNumber

        public org.opendaylight.yangtools.yang.common.Uint16 getMyAsNumber()

      • augmentation

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

      • setBgpIdentifier

        public SentOpenBuilder setBgpIdentifier​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)

      • setHoldTimer

        public SentOpenBuilder setHoldTimer​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setHoldTimer

        @Deprecated(forRemoval=true)
public SentOpenBuilder setHoldTimer​(Integer value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setHoldTimer(Uint16)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setMyAsNumber

        public SentOpenBuilder setMyAsNumber​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setMyAsNumber

        @Deprecated(forRemoval=true)
public SentOpenBuilder setMyAsNumber​(Integer value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setMyAsNumber(Uint16)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • addAugmentation

        public SentOpenBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SentOpen>> augmentationType,
                                       org.opendaylight.yangtools.yang.binding.Augmentation<SentOpen> augmentationValue)

      • removeAugmentation

        public SentOpenBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SentOpen>> augmentationType)

      • build

        public SentOpen build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<SentOpen>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<SentOpen,​IllegalArgumentException>