Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911

Class AdjacenciesOpBuilder

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

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

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

    • Constructor Detail

      • AdjacenciesOpBuilder

        public AdjacenciesOpBuilder()

      • AdjacenciesOpBuilder

        public AdjacenciesOpBuilder​(AdjacencyList arg)

      • AdjacenciesOpBuilder

        public AdjacenciesOpBuilder​(AdjacenciesOp 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.netvirt.neutronvpn.l3vpn.rev200204.AdjacencyList
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • setAdjacency

        @Deprecated(forRemoval=true)
public AdjacenciesOpBuilder setAdjacency​(java.util.List<Adjacency> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setAdjacency(Map) instead.
        Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.
        Parameters:
        values - Legacy List of values
        Returns:
        this builder
        Throws:
        java.lang.IllegalArgumentException - if the list contains entries with the same key
        java.lang.NullPointerException - if the list contains a null entry

      • build

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