Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.nxm.of.match.tcp.dst.grouping

Class TcpDstValuesBuilder

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

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

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

    • Constructor Detail

      • TcpDstValuesBuilder

        public TcpDstValuesBuilder()

      • TcpDstValuesBuilder

        public TcpDstValuesBuilder​(TcpDstValues base)

    • Method Detail

      • getMask

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

      • getPort

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

      • augmentation

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

      • setMask

        public TcpDstValuesBuilder setMask​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setMask

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

      • setPort

        public TcpDstValuesBuilder setPort​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)

      • addAugmentation

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