Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.vlan.match.fields

Class VlanIdBuilder

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

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

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

    • Constructor Detail

      • VlanIdBuilder

        public VlanIdBuilder()

      • VlanIdBuilder

        public VlanIdBuilder​(VlanId base)

    • Method Detail

      • getVlanId

        public org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId getVlanId()

      • getVlanIdPresent

        public Boolean getVlanIdPresent()

      • isVlanIdPresent

        @Deprecated(forRemoval=true)
public final Boolean isVlanIdPresent()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • augmentation

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

      • setVlanId

        public VlanIdBuilder setVlanId​(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId value)

      • addAugmentation

        public VlanIdBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<VlanId> 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 VlanIdBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanId>> 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 VlanId build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<VlanId>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<VlanId,​IllegalArgumentException>