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

Class PacketInMessageBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<PacketInMessage>, org.opendaylight.yangtools.concepts.CheckedBuilder<PacketInMessage,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class PacketInMessageBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<PacketInMessage>
    Class that builds PacketInMessageBuilder 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: 

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

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

    • Constructor Detail

      • PacketInMessageBuilder

        public PacketInMessageBuilder()

      • PacketInMessageBuilder

        public PacketInMessageBuilder​(PacketIn arg)

      • PacketInMessageBuilder

        public PacketInMessageBuilder​(RawPacket arg)

      • PacketInMessageBuilder

        public PacketInMessageBuilder​(OfHeader arg)

      • PacketInMessageBuilder

        public PacketInMessageBuilder​(PacketInMessage 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.packet.service.rev130709.RawPacket
        • org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketIn
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getFlowCookie

        public FlowCookie getFlowCookie()

      • getIngress

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

      • getMatch

        public Match getMatch()

      • getPayload

        public byte[] getPayload()

      • getTableId

        public TableId getTableId()

      • getVersion

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

      • getXid

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

      • augmentation

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

      • setIngress

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

      • setVersion

        public PacketInMessageBuilder setVersion​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setVersion

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

      • setXid

        @Deprecated(forRemoval=true)
public PacketInMessageBuilder setXid​(Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setXid(Uint32)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder