Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.elan.instance

Class ElanSegmentsBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<ElanSegments>, org.opendaylight.yangtools.concepts.CheckedBuilder<ElanSegments,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class ElanSegmentsBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<ElanSegments>
    Class that builds ElanSegmentsBuilder 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: 

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

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

    • Constructor Detail

      • ElanSegmentsBuilder

        public ElanSegmentsBuilder()

      • ElanSegmentsBuilder

        public ElanSegmentsBuilder​(ElanSegments base)

    • Method Detail

      • getPhysicalNetworkName

        public java.lang.String getPhysicalNetworkName()

      • getSegmentType

        public java.lang.Class<? extends SegmentTypeBase> getSegmentType()

      • getSegmentationId

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

      • getSegmentationIndex

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

      • augmentation

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

      • setPhysicalNetworkName

        public ElanSegmentsBuilder setPhysicalNetworkName​(java.lang.String value)

      • setSegmentationId

        public ElanSegmentsBuilder setSegmentationId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setSegmentationId

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

      • setSegmentationIndex

        public ElanSegmentsBuilder setSegmentationIndex​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setSegmentationIndex

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

      • addAugmentation

        public ElanSegmentsBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ElanSegments>> augmentationType,
                                           org.opendaylight.yangtools.yang.binding.Augmentation<ElanSegments> augmentationValue)

      • removeAugmentation

        public ElanSegmentsBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ElanSegments>> augmentationType)

      • build

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