Package org.opendaylight.yang.gen.v1.urn.lighty.gnmi.topology.rev210316

Class GnmiNodeBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<GnmiNode>, org.opendaylight.yangtools.concepts.CheckedBuilder<GnmiNode,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class GnmiNodeBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<GnmiNode>
    Class that builds GnmiNodeBuilder 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: 

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

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

    • Constructor Detail

      • GnmiNodeBuilder

        public GnmiNodeBuilder()

      • GnmiNodeBuilder

        public GnmiNodeBuilder​(GnmiNode 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.lighty.gnmi.topology.rev210316.GnmiNodeState
        • org.opendaylight.yang.gen.v1.urn.lighty.gnmi.topology.rev210316.GnmiConnectionParameters
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getNodeState

        public NodeState getNodeState()

      • build

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