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

Class PbbBuilder

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

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

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

    • Constructor Detail

      • PbbBuilder

        public PbbBuilder()

      • PbbBuilder

        public PbbBuilder​(Pbb base)

    • Method Detail

      • getPbbIsid

        public org.opendaylight.yangtools.yang.common.Uint32 getPbbIsid()

      • getPbbMask

        public org.opendaylight.yangtools.yang.common.Uint32 getPbbMask()

      • augmentation

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

      • setPbbIsid

        public PbbBuilder setPbbIsid​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setPbbIsid

        @Deprecated(forRemoval=true)
public PbbBuilder setPbbIsid​(Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setPbbIsid(Uint32) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setPbbMask

        public PbbBuilder setPbbMask​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setPbbMask

        @Deprecated(forRemoval=true)
public PbbBuilder setPbbMask​(Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setPbbMask(Uint32) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • addAugmentation

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