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

Class TcpMatchBuilder

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

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

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

    • Constructor Detail

      • TcpMatchBuilder

        public TcpMatchBuilder()

      • TcpMatchBuilder

        public TcpMatchBuilder​(TcpMatch 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.TcpMatchFields
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getTcpDestinationPort

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

      • getTcpDestinationPortMask

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

      • getTcpSourcePort

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

      • getTcpSourcePortMask

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

      • augmentation

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

      • setTcpDestinationPort

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

      • setTcpDestinationPortMask

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

      • setTcpSourcePort

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

      • setTcpSourcePortMask

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

      • addAugmentation

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

      • build

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