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

Class Neighbor1Builder

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

       
     Neighbor1 createNeighbor1(int fooXyzzy, int barBaz) {
         return new Neighbor1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • Neighbor1Builder

        public Neighbor1Builder()

      • Neighbor1Builder

        public Neighbor1Builder​(Neighbor1 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:
        • BgpUseMultiplePathsNeighbor
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value