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

Class TransmitPacketInputBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.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>

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 Summary

Constructors

Constructor and Description
TransmitPacketInputBuilder()
TransmitPacketInputBuilder(ActionList arg)
TransmitPacketInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
TransmitPacketInputBuilder(RawPacket arg)
TransmitPacketInputBuilder(TransmitPacketInput base)

Method Summary

Modifier and Type	Method and Description
TransmitPacketInputBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TransmitPacketInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TransmitPacketInput> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TransmitPacketInput>> E$$	augmentation(Class<E$$> augmentationType)
TransmitPacketInput	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
List<Action>	getAction()
Long	getBufferId()
ConnectionCookie	getConnectionCookie()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef	getEgress()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef	getIngress()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef	getNode()
byte[]	getPayload()
TransmitPacketInputBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TransmitPacketInput>> augmentationType)
TransmitPacketInputBuilder	setAction(List<Action> values)
TransmitPacketInputBuilder	setBufferId(Long value)
TransmitPacketInputBuilder	setConnectionCookie(ConnectionCookie value)
TransmitPacketInputBuilder	setEgress(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef value)
TransmitPacketInputBuilder	setIngress(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef value)
TransmitPacketInputBuilder	setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
TransmitPacketInputBuilder	setPayload(byte[] value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransmitPacketInputBuilder

public TransmitPacketInputBuilder()

TransmitPacketInputBuilder

public TransmitPacketInputBuilder(RawPacket arg)

TransmitPacketInputBuilder

public TransmitPacketInputBuilder(ActionList arg)

TransmitPacketInputBuilder

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

TransmitPacketInputBuilder

public TransmitPacketInputBuilder(TransmitPacketInput 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.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

getAction

public List<Action> getAction()

getBufferId

public Long getBufferId()

getConnectionCookie

public ConnectionCookie getConnectionCookie()

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

public TransmitPacketInputBuilder setAction(List<Action> values)

setBufferId

public TransmitPacketInputBuilder setBufferId(Long value)

setConnectionCookie

public TransmitPacketInputBuilder setConnectionCookie(ConnectionCookie value)

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)

setPayload

public TransmitPacketInputBuilder setPayload(byte[] value)

addAugmentation

public TransmitPacketInputBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TransmitPacketInput>> augmentationType,
                                                  org.opendaylight.yangtools.yang.binding.Augmentation<TransmitPacketInput> augmentationValue)

removeAugmentation

public TransmitPacketInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TransmitPacketInput>> augmentationType)

build

public TransmitPacketInput build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<TransmitPacketInput,IllegalArgumentException>