Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.v10.grouping

Class MatchV10Builder

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

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

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

    • Constructor Detail

      • MatchV10Builder

        public MatchV10Builder()

      • MatchV10Builder

        public MatchV10Builder​(MatchV10 base)

    • Method Detail

      • getDlDst

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getDlDst()

      • getDlSrc

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getDlSrc()

      • getDlType

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

      • getDlVlan

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

      • getDlVlanPcp

        public org.opendaylight.yangtools.yang.common.Uint8 getDlVlanPcp()

      • getInPort

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

      • getNwDst

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

      • getNwDstMask

        public org.opendaylight.yangtools.yang.common.Uint8 getNwDstMask()

      • getNwProto

        public org.opendaylight.yangtools.yang.common.Uint8 getNwProto()

      • getNwSrc

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

      • getNwSrcMask

        public org.opendaylight.yangtools.yang.common.Uint8 getNwSrcMask()

      • getNwTos

        public org.opendaylight.yangtools.yang.common.Uint8 getNwTos()

      • getTpDst

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

      • getTpSrc

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

      • augmentation

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

      • setDlDst

        public MatchV10Builder setDlDst​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)

      • setDlSrc

        public MatchV10Builder setDlSrc​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)

      • setDlType

        public MatchV10Builder setDlType​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setDlType

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

      • setDlVlan

        public MatchV10Builder setDlVlan​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setDlVlan

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

      • setDlVlanPcp

        public MatchV10Builder setDlVlanPcp​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setDlVlanPcp

        @Deprecated(forRemoval=true)
public MatchV10Builder setDlVlanPcp​(Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setDlVlanPcp(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setInPort

        public MatchV10Builder setInPort​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setInPort

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

      • setNwDst

        public MatchV10Builder setNwDst​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)

      • setNwDstMask

        public MatchV10Builder setNwDstMask​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setNwDstMask

        @Deprecated(forRemoval=true)
public MatchV10Builder setNwDstMask​(Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setNwDstMask(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setNwProto

        public MatchV10Builder setNwProto​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setNwProto

        @Deprecated(forRemoval=true)
public MatchV10Builder setNwProto​(Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setNwProto(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setNwSrc

        public MatchV10Builder setNwSrc​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)

      • setNwSrcMask

        public MatchV10Builder setNwSrcMask​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setNwSrcMask

        @Deprecated(forRemoval=true)
public MatchV10Builder setNwSrcMask​(Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setNwSrcMask(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setNwTos

        public MatchV10Builder setNwTos​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setNwTos

        @Deprecated(forRemoval=true)
public MatchV10Builder setNwTos​(Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setNwTos(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setTpDst

        public MatchV10Builder setTpDst​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setTpDst

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

      • setTpSrc

        public MatchV10Builder setTpSrc​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setTpSrc

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

      • addAugmentation

        public MatchV10Builder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<MatchV10> 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 MatchV10Builder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchV10>> 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 MatchV10 build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<MatchV10>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<MatchV10,​IllegalArgumentException>