Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.vlan.rev190416.vlan.top.vlans

Class VlanBuilder

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

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

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

    • Constructor Detail

      • VlanBuilder

        public VlanBuilder()

      • VlanBuilder

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

      • getConfig

        public Config getConfig()

      • getMembers

        public Members getMembers()

      • getState

        public State getState()

      • getVlanId

        public VlanId getVlanId()

      • augmentation

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

      • addAugmentation

        public VlanBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Vlan> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        NullPointerException - if augmentation is null

      • removeAugmentation

        public VlanBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vlan>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        Parameters:
        augmentationType - augmentation type to be removed
        Returns:
        this builder

      • build

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