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

Class VlanBuilder

  • @Generated("mdsal-binding-generator")
public class VlanBuilder
extends Object
    Class that builds Vlan 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: 

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

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

    • Constructor Detail

      • VlanBuilder

        public VlanBuilder()
        Construct an empty builder.

      • VlanBuilder

        public VlanBuilder​(VlanMembersState arg)
        Construct a new builder initialized from specified VlanMembersState.
        Parameters:
        arg - VlanMembersState from which the builder should be initialized

      • VlanBuilder

        public VlanBuilder​(Vlan base)
        Construct a builder initialized with state from specified Vlan.
        Parameters:
        base - Vlan from which the builder should be initialized

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

      • key

        public VlanKey key()
        Return current value associated with the property corresponding to Vlan.key().
        Returns:
        current value

      • getConfig

        public Config getConfig()
        Return current value associated with the property corresponding to Vlan.getConfig().
        Returns:
        current value

      • getState

        public State getState()
        Return current value associated with the property corresponding to Vlan.getState().
        Returns:
        current value

      • getVlanId

        public VlanId getVlanId()
        Return current value associated with the property corresponding to Vlan.getVlanId().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Vlan>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        Parameters:
        augmentationType - augmentation type class
        Returns:
        Augmentation object from this builder, or null if not present
        Throws:
        NullPointerException - if augmentType is null

      • setConfig

        public VlanBuilder setConfig​(Config value)
        Set the property corresponding to Vlan.getConfig() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setState

        public VlanBuilder setState​(State value)
        Set the property corresponding to Vlan.getState() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setVlanId

        public VlanBuilder setVlanId​(VlanId value)
        Set the property corresponding to Vlan.getVlanId() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • 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 @NonNull Vlan build()
        A new Vlan instance.
        Returns:
        A new Vlan instance.