Class PacketInMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketInMessageBuilder
-
@Generated("mdsal-binding-generator") public class PacketInMessageBuilder extends Object
Class that buildsPacketInMessage
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:
PacketInMessage createPacketInMessage(int fooXyzzy, int barBaz) { return new PacketInMessageBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PacketInMessage, 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:
PacketInMessage
- 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 PacketInMessageBuilder()
Construct an empty builder.PacketInMessageBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.PacketInMessageBuilder(PacketIn arg)
Construct a new builder initialized from specifiedPacketIn
.PacketInMessageBuilder(PacketInMessage base)
Construct a builder initialized with state from specifiedPacketInMessage
.PacketInMessageBuilder(RawPacket arg)
Construct a new builder initialized from specifiedRawPacket
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PacketInMessageBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMessage> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMessage>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PacketInMessage
build()
A newPacketInMessage
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 toPacketInMessage.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()
.org.opendaylight.yangtools.yang.common.Uint8
getVersion()
Return current value associated with the property corresponding toOfHeader.getVersion()
.org.opendaylight.yangtools.yang.common.Uint32
getXid()
Return current value associated with the property corresponding toOfHeader.getXid()
.PacketInMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMessage>> augmentationType)
Remove an augmentation from this builder's product.PacketInMessageBuilder
setConnectionCookie(ConnectionCookie value)
Set the property corresponding toPacketIn.getConnectionCookie()
to the specified value.PacketInMessageBuilder
setFlowCookie(FlowCookie value)
Set the property corresponding toPacketIn.getFlowCookie()
to the specified value.PacketInMessageBuilder
setIngress(NodeConnectorRef value)
Set the property corresponding toRawPacket.getIngress()
to the specified value.PacketInMessageBuilder
setMatch(Match value)
Set the property corresponding toPacketInMessage.getMatch()
to the specified value.PacketInMessageBuilder
setPacketInReason(Class<? extends PacketInReason> value)
Set the property corresponding toPacketIn.getPacketInReason()
to the specified value.PacketInMessageBuilder
setPayload(byte[] value)
Set the property corresponding toRawPacket.getPayload()
to the specified value.PacketInMessageBuilder
setTableId(TableId value)
Set the property corresponding toPacketIn.getTableId()
to the specified value.PacketInMessageBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.PacketInMessageBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.
-
-
-
Constructor Detail
-
PacketInMessageBuilder
public PacketInMessageBuilder()
Construct an empty builder.
-
PacketInMessageBuilder
public PacketInMessageBuilder(PacketIn arg)
Construct a new builder initialized from specifiedPacketIn
.- Parameters:
arg
- PacketIn from which the builder should be initialized
-
PacketInMessageBuilder
public PacketInMessageBuilder(RawPacket arg)
Construct a new builder initialized from specifiedRawPacket
.- Parameters:
arg
- RawPacket from which the builder should be initialized
-
PacketInMessageBuilder
public PacketInMessageBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.- Parameters:
arg
- OfHeader from which the builder should be initialized
-
PacketInMessageBuilder
public PacketInMessageBuilder(PacketInMessage base)
Construct a builder initialized with state from specifiedPacketInMessage
.- Parameters:
base
- PacketInMessage 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 toPacketInMessage.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
-
getVersion
public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
Return current value associated with the property corresponding toOfHeader.getVersion()
.- Returns:
- current value
-
getXid
public org.opendaylight.yangtools.yang.common.Uint32 getXid()
Return current value associated with the property corresponding toOfHeader.getXid()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMessage>> 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 PacketInMessageBuilder setConnectionCookie(ConnectionCookie value)
Set the property corresponding toPacketIn.getConnectionCookie()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowCookie
public PacketInMessageBuilder setFlowCookie(FlowCookie value)
Set the property corresponding toPacketIn.getFlowCookie()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIngress
public PacketInMessageBuilder setIngress(NodeConnectorRef value)
Set the property corresponding toRawPacket.getIngress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatch
public PacketInMessageBuilder setMatch(Match value)
Set the property corresponding toPacketInMessage.getMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketInReason
public PacketInMessageBuilder setPacketInReason(Class<? extends PacketInReason> value)
Set the property corresponding toPacketIn.getPacketInReason()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPayload
public PacketInMessageBuilder setPayload(byte[] value)
Set the property corresponding toRawPacket.getPayload()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
public PacketInMessageBuilder setTableId(TableId value)
Set the property corresponding toPacketIn.getTableId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
public PacketInMessageBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXid
public PacketInMessageBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PacketInMessageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMessage> 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 PacketInMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMessage>> 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 PacketInMessage build()
A newPacketInMessage
instance.- Returns:
- A new
PacketInMessage
instance.
-
-