Class PacketReceivedBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceivedBuilder
-
@Generated("mdsal-binding-generator") public class PacketReceivedBuilder extends Object
Class that buildsPacketReceived
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:
PacketReceived createPacketReceived(int fooXyzzy, int barBaz) { return new PacketReceivedBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PacketReceived, 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:
PacketReceived
- 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
-
-
Constructor Summary
Constructors Constructor Description PacketReceivedBuilder()
Construct an empty builder.PacketReceivedBuilder(PacketIn arg)
Construct a new builder initialized from specifiedPacketIn
.PacketReceivedBuilder(PacketReceived base)
Construct a builder initialized with state from specifiedPacketReceived
.PacketReceivedBuilder(RawPacket arg)
Construct a new builder initialized from specifiedRawPacket
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull PacketReceived
build()
A newPacketReceived
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ConnectionCookie
getConnectionCookie()
Return current value associated with the property corresponding toPacketIn.getConnectionCookie()
.FlowCookie
getFlowCookie()
Return current value associated with the property corresponding toPacketIn.getFlowCookie()
.NodeConnectorRef
getIngress()
Return current value associated with the property corresponding toRawPacket.getIngress()
.Match
getMatch()
Return current value associated with the property corresponding toPacketReceived.getMatch()
.Class<? extends PacketInReason>
getPacketInReason()
Return current value associated with the property corresponding toPacketIn.getPacketInReason()
.byte[]
getPayload()
Return current value associated with the property corresponding toRawPacket.getPayload()
.TableId
getTableId()
Return current value associated with the property corresponding toPacketIn.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)
Set the property corresponding toPacketIn.getConnectionCookie()
to the specified value.PacketReceivedBuilder
setFlowCookie(FlowCookie value)
Set the property corresponding toPacketIn.getFlowCookie()
to the specified value.PacketReceivedBuilder
setIngress(NodeConnectorRef value)
Set the property corresponding toRawPacket.getIngress()
to the specified value.PacketReceivedBuilder
setMatch(Match value)
Set the property corresponding toPacketReceived.getMatch()
to the specified value.PacketReceivedBuilder
setPacketInReason(Class<? extends PacketInReason> value)
Set the property corresponding toPacketIn.getPacketInReason()
to the specified value.PacketReceivedBuilder
setPayload(byte[] value)
Set the property corresponding toRawPacket.getPayload()
to the specified value.PacketReceivedBuilder
setTableId(TableId value)
Set the property corresponding toPacketIn.getTableId()
to the specified value.
-
-
-
Constructor Detail
-
PacketReceivedBuilder
public PacketReceivedBuilder()
Construct an empty builder.
-
PacketReceivedBuilder
public PacketReceivedBuilder(PacketIn arg)
Construct a new builder initialized from specifiedPacketIn
.- Parameters:
arg
- PacketIn from which the builder should be initialized
-
PacketReceivedBuilder
public PacketReceivedBuilder(RawPacket arg)
Construct a new builder initialized from specifiedRawPacket
.- Parameters:
arg
- RawPacket from which the builder should be initialized
-
PacketReceivedBuilder
public PacketReceivedBuilder(PacketReceived base)
Construct a builder initialized with state from specifiedPacketReceived
.- Parameters:
base
- PacketReceived 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
-
getConnectionCookie
public ConnectionCookie getConnectionCookie()
Return current value associated with the property corresponding toPacketIn.getConnectionCookie()
.- Returns:
- current value
-
getFlowCookie
public FlowCookie getFlowCookie()
Return current value associated with the property corresponding toPacketIn.getFlowCookie()
.- Returns:
- current value
-
getIngress
public NodeConnectorRef getIngress()
Return current value associated with the property corresponding toRawPacket.getIngress()
.- Returns:
- current value
-
getMatch
public Match getMatch()
Return current value associated with the property corresponding toPacketReceived.getMatch()
.- Returns:
- current value
-
getPacketInReason
public Class<? extends PacketInReason> getPacketInReason()
Return current value associated with the property corresponding toPacketIn.getPacketInReason()
.- Returns:
- current value
-
getPayload
public byte[] getPayload()
Return current value associated with the property corresponding toRawPacket.getPayload()
.- Returns:
- current value
-
getTableId
public TableId getTableId()
Return current value associated with the property corresponding toPacketIn.getTableId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketReceived>> 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
- ifaugmentType
isnull
-
setConnectionCookie
public PacketReceivedBuilder setConnectionCookie(ConnectionCookie value)
Set the property corresponding toPacketIn.getConnectionCookie()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowCookie
public PacketReceivedBuilder setFlowCookie(FlowCookie value)
Set the property corresponding toPacketIn.getFlowCookie()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIngress
public PacketReceivedBuilder setIngress(NodeConnectorRef value)
Set the property corresponding toRawPacket.getIngress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatch
public PacketReceivedBuilder setMatch(Match value)
Set the property corresponding toPacketReceived.getMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketInReason
public PacketReceivedBuilder setPacketInReason(Class<? extends PacketInReason> value)
Set the property corresponding toPacketIn.getPacketInReason()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPayload
public PacketReceivedBuilder setPayload(byte[] value)
Set the property corresponding toRawPacket.getPayload()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
public PacketReceivedBuilder setTableId(TableId value)
Set the property corresponding toPacketIn.getTableId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull PacketReceived build()
A newPacketReceived
instance.- Returns:
- A new
PacketReceived
instance.
-
-