Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state

Class PeerPrefBuilder

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

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

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

    • Constructor Detail

      • PeerPrefBuilder

        public PeerPrefBuilder()

      • PeerPrefBuilder

        public PeerPrefBuilder​(Preferences arg)

      • PeerPrefBuilder

        public PeerPrefBuilder​(PeerPref 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.pcep.stats.rev171113.Preferences
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getDeadtimer

        public org.opendaylight.yangtools.yang.common.Uint8 getDeadtimer()

      • getIpAddress

        public String getIpAddress()

      • getKeepalive

        public org.opendaylight.yangtools.yang.common.Uint8 getKeepalive()

      • getSessionId

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

      • augmentation

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

      • setDeadtimer

        public PeerPrefBuilder setDeadtimer​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setDeadtimer

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

      • setKeepalive

        public PeerPrefBuilder setKeepalive​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setKeepalive

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

      • setSessionId

        public PeerPrefBuilder setSessionId​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setSessionId

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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