Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.neutron.vip.states

Class VipStateBuilder

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

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

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

    • Constructor Detail

      • VipStateBuilder

        public VipStateBuilder()

      • VipStateBuilder

        public VipStateBuilder​(VipState base)

    • Method Detail

      • getDpnId

        public org.opendaylight.yangtools.yang.common.Uint64 getDpnId()

      • getIfcName

        public java.lang.String getIfcName()

      • getIp

        public java.lang.String getIp()

      • augmentation

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

      • setDpnId

        public VipStateBuilder setDpnId​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setDpnId

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

      • setIfcName

        public VipStateBuilder setIfcName​(java.lang.String value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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