Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.p2p.rev130819.tunnel.p2p.path.oper.attributes

Class ReportedHopsBuilder

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

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

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

    • Constructor Detail

      • ReportedHopsBuilder

        public ReportedHopsBuilder()

      • ReportedHopsBuilder

        public ReportedHopsBuilder​(ReportedHops 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.topology.tunnel.p2p.rev130819.TunnelP2pPathHops
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getOrder

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

      • augmentation

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

      • setOrder

        public ReportedHopsBuilder setOrder​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setOrder

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

      • addAugmentation

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