Package org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.set.field._case

Class SetFieldBuilder

  • @Generated("mdsal-binding-generator")
public class SetFieldBuilder
extends Object
    Class that builds SetField 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: 

       
     SetField createSetField(int fooXyzzy, int barBaz) {
         return new SetFieldBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • SetFieldBuilder

        public SetFieldBuilder()
        Construct an empty builder.

      • SetFieldBuilder

        public SetFieldBuilder​(Match arg)
        Construct a new builder initialized from specified Match.
        Parameters:
        arg - Match from which the builder should be initialized

      • SetFieldBuilder

        public SetFieldBuilder​(SetField base)
        Construct a builder initialized with state from specified SetField.
        Parameters:
        base - SetField from which the builder should be initialized

    • 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:
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getIcmpv4Match

        public Icmpv4Match getIcmpv4Match()
        Return current value associated with the property corresponding to Match.getIcmpv4Match().
        Returns:
        current value

      • getIcmpv6Match

        public Icmpv6Match getIcmpv6Match()
        Return current value associated with the property corresponding to Match.getIcmpv6Match().
        Returns:
        current value

      • getIpMatch

        public IpMatch getIpMatch()
        Return current value associated with the property corresponding to Match.getIpMatch().
        Returns:
        current value

      • getLayer3Match

        public Layer3Match getLayer3Match()
        Return current value associated with the property corresponding to Match.getLayer3Match().
        Returns:
        current value

      • getLayer4Match

        public Layer4Match getLayer4Match()
        Return current value associated with the property corresponding to Match.getLayer4Match().
        Returns:
        current value

      • getMetadata

        public Metadata getMetadata()
        Return current value associated with the property corresponding to Match.getMetadata().
        Returns:
        current value

      • getTunnel

        public Tunnel getTunnel()
        Return current value associated with the property corresponding to Match.getTunnel().
        Returns:
        current value

      • getVlanMatch

        public VlanMatch getVlanMatch()
        Return current value associated with the property corresponding to Match.getVlanMatch().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetField>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        Parameters:
        augmentationType - augmentation type class
        Returns:
        Augmentation object from this builder, or null if not present
        Throws:
        NullPointerException - if augmentType is null

      • setIpMatch

        public SetFieldBuilder setIpMatch​(IpMatch value)
        Set the property corresponding to Match.getIpMatch() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setTunnel

        public SetFieldBuilder setTunnel​(Tunnel value)
        Set the property corresponding to Match.getTunnel() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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