Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.ofpact.actions.ofpact.actions.nx.action.nat._case

Class NxActionNatBuilder

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

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

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

    • Constructor Detail

      • NxActionNatBuilder

        public NxActionNatBuilder()

      • NxActionNatBuilder

        public NxActionNatBuilder​(NxActionNat base)

    • Method Detail

      • getFlags

        public org.opendaylight.yangtools.yang.common.Uint16 getFlags()

      • getIpAddressMax

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpAddressMax()

      • getIpAddressMin

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpAddressMin()

      • getPortMax

        public org.opendaylight.yangtools.yang.common.Uint16 getPortMax()

      • getPortMin

        public org.opendaylight.yangtools.yang.common.Uint16 getPortMin()

      • getRangePresent

        public org.opendaylight.yangtools.yang.common.Uint16 getRangePresent()

      • augmentation

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

      • setFlags

        public NxActionNatBuilder setFlags​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setFlags

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

      • setIpAddressMax

        public NxActionNatBuilder setIpAddressMax​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)

      • setIpAddressMin

        public NxActionNatBuilder setIpAddressMin​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)

      • setPortMax

        public NxActionNatBuilder setPortMax​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setPortMax

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

      • setPortMin

        public NxActionNatBuilder setPortMin​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setPortMin

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

      • setRangePresent

        public NxActionNatBuilder setRangePresent​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setRangePresent

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

      • addAugmentation

        public NxActionNatBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionNat>> augmentationType,
                                          org.opendaylight.yangtools.yang.binding.Augmentation<NxActionNat> augmentationValue)

      • removeAugmentation

        public NxActionNatBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionNat>> augmentationType)