Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406

Class ParentRefsBuilder

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

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

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

    • Constructor Detail

      • ParentRefsBuilder

        public ParentRefsBuilder()

      • ParentRefsBuilder

        public ParentRefsBuilder​(ParentRefs base)

    • Method Detail

      • getDatapathNodeIdentifier

        public org.opendaylight.yangtools.yang.common.Uint64 getDatapathNodeIdentifier()

      • getParentInterface

        public java.lang.String getParentInterface()

      • setDatapathNodeIdentifier

        public ParentRefsBuilder setDatapathNodeIdentifier​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setDatapathNodeIdentifier

        @Deprecated(forRemoval=true)
public ParentRefsBuilder setDatapathNodeIdentifier​(java.math.BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setDatapathNodeIdentifier(Uint64) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setNodeIdentifier

        @Deprecated(forRemoval=true)
public ParentRefsBuilder setNodeIdentifier​(java.util.List<NodeIdentifier> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setNodeIdentifier(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

      • setParentInterface

        public ParentRefsBuilder setParentInterface​(java.lang.String value)

      • build

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