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

Class TcpFlagsMatchBuilder

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

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

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

    • Constructor Detail

      • TcpFlagsMatchBuilder

        public TcpFlagsMatchBuilder()

      • TcpFlagsMatchBuilder

        public TcpFlagsMatchBuilder​(TcpFlagsMatch base)

    • Method Detail

      • fieldsFrom

        public void fieldsFrom​(org.opendaylight.yangtools.yang.binding.DataObject arg)
        Set fields from given grouping argument. Valid argument is instance of one of following types:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.TcpFlagsMatchFields
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getTcpFlags

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

      • getTcpFlagsMask

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

      • augmentation

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

      • setTcpFlags

        public TcpFlagsMatchBuilder setTcpFlags​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setTcpFlagsMask

        public TcpFlagsMatchBuilder setTcpFlagsMask​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • addAugmentation

        public TcpFlagsMatchBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<TcpFlagsMatch> 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 TcpFlagsMatchBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpFlagsMatch>> 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