Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329

Class PeerGroupStateAugmentationBuilder

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

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

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

    • Constructor Detail

      • PeerGroupStateAugmentationBuilder

        public PeerGroupStateAugmentationBuilder()

      • PeerGroupStateAugmentationBuilder

        public PeerGroupStateAugmentationBuilder​(BgpPeerGroupState arg)

    • 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.http.openconfig.net.yang.bgp.operational.rev151009.BgpPeerGroupState
        • org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.operational.rev151009.BgpContextPfxPathCountersCommon
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getTotalPaths

        public org.opendaylight.yangtools.yang.common.Uint32 getTotalPaths()

      • getTotalPrefixes

        public org.opendaylight.yangtools.yang.common.Uint32 getTotalPrefixes()

      • setTotalPaths

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

      • setTotalPrefixes

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