Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.global.base

Class StateBuilder

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

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

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

    • 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.BgpGlobalState
        • org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.BgpGlobalConfig
        • 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

      • getAs

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

      • getRouterId

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

      • getTotalPaths

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

      • getTotalPrefixes

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

      • augmentation

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

      • setAs

        public StateBuilder setAs​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)

      • setRouterId

        public StateBuilder setRouterId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)

      • setTotalPaths

        public StateBuilder setTotalPaths​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setTotalPaths

        @Deprecated(forRemoval=true)
public StateBuilder 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

        public StateBuilder setTotalPrefixes​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setTotalPrefixes

        @Deprecated(forRemoval=true)
public StateBuilder 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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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