Class PacketReceivedBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceivedBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PacketReceived>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PacketReceived,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PacketReceivedBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PacketReceived>
Class that buildsPacketReceivedBuilder
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:
PacketReceivedBuilder createTarget(int fooXyzzy, int barBaz) { return new PacketReceivedBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PacketReceivedBuilder, 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:
PacketReceivedBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PacketReceivedBuilder()
PacketReceivedBuilder(PacketIn arg)
PacketReceivedBuilder(PacketReceived base)
PacketReceivedBuilder(RawPacket arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PacketReceivedBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketReceived> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketReceived>>
E$$augmentation(Class<E$$> augmentationType)
PacketReceived
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ConnectionCookie
getConnectionCookie()
FlowCookie
getFlowCookie()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef
getIngress()
Match
getMatch()
Class<? extends PacketInReason>
getPacketInReason()
byte[]
getPayload()
TableId
getTableId()
PacketReceivedBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketReceived>> augmentationType)
Remove an augmentation from this builder's product.PacketReceivedBuilder
setConnectionCookie(ConnectionCookie value)
PacketReceivedBuilder
setFlowCookie(FlowCookie value)
PacketReceivedBuilder
setIngress(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef value)
PacketReceivedBuilder
setMatch(Match value)
PacketReceivedBuilder
setPacketInReason(Class<? extends PacketInReason> value)
PacketReceivedBuilder
setPayload(byte[] value)
PacketReceivedBuilder
setTableId(TableId value)
-
-
-
Constructor Detail
-
PacketReceivedBuilder
public PacketReceivedBuilder()
-
PacketReceivedBuilder
public PacketReceivedBuilder(PacketIn arg)
-
PacketReceivedBuilder
public PacketReceivedBuilder(RawPacket arg)
-
PacketReceivedBuilder
public PacketReceivedBuilder(PacketReceived 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
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getConnectionCookie
public ConnectionCookie getConnectionCookie()
-
getFlowCookie
public FlowCookie getFlowCookie()
-
getIngress
public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef getIngress()
-
getMatch
public Match getMatch()
-
getPacketInReason
public Class<? extends PacketInReason> getPacketInReason()
-
getPayload
public byte[] getPayload()
-
getTableId
public TableId getTableId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketReceived>> E$$ augmentation(Class<E$$> augmentationType)
-
setConnectionCookie
public PacketReceivedBuilder setConnectionCookie(ConnectionCookie value)
-
setFlowCookie
public PacketReceivedBuilder setFlowCookie(FlowCookie value)
-
setIngress
public PacketReceivedBuilder setIngress(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef value)
-
setMatch
public PacketReceivedBuilder setMatch(Match value)
-
setPacketInReason
public PacketReceivedBuilder setPacketInReason(Class<? extends PacketInReason> value)
-
setPayload
public PacketReceivedBuilder setPayload(byte[] value)
-
setTableId
public PacketReceivedBuilder setTableId(TableId value)
-
addAugmentation
public PacketReceivedBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketReceived> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public PacketReceivedBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketReceived>> 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 PacketReceived build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PacketReceived>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PacketReceived,IllegalArgumentException>
-
-