Package org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709

Class TransmitPacketInputBuilder

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

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

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

    • Constructor Detail

      • TransmitPacketInputBuilder

        public TransmitPacketInputBuilder()

      • TransmitPacketInputBuilder

        public TransmitPacketInputBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)

      • TransmitPacketInputBuilder

        public TransmitPacketInputBuilder​(RawPacket arg)

      • TransmitPacketInputBuilder

        public TransmitPacketInputBuilder​(ActionList arg)

    • 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.action.types.rev131112.ActionList
        • org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.RawPacket
        • org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getBufferId

        public org.opendaylight.yangtools.yang.common.Uint32 getBufferId()

      • getEgress

        public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef getEgress()

      • getIngress

        public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef getIngress()

      • getNode

        public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef getNode()

      • getPayload

        public byte[] getPayload()

      • augmentation

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

      • setAction

        @Deprecated(forRemoval=true)
public TransmitPacketInputBuilder setAction​(List<Action> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setAction(Map) instead.
        Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.
        Parameters:
        values - Legacy List of values
        Returns:
        this builder
        Throws:
        IllegalArgumentException - if the list contains entries with the same key
        NullPointerException - if the list contains a null entry

      • setEgress

        public TransmitPacketInputBuilder setEgress​(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef value)

      • setIngress

        public TransmitPacketInputBuilder setIngress​(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef value)

      • setNode

        public TransmitPacketInputBuilder setNode​(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)

      • addAugmentation

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