Class PacketInMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.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>
@Generated("mdsal-binding-generator") public class PacketInMessageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PacketInMessage>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description PacketInMessageBuilder()
PacketInMessageBuilder(MatchGrouping arg)
PacketInMessageBuilder(OfHeader arg)
PacketInMessageBuilder(PacketIn arg)
PacketInMessageBuilder(PacketInMessage base)
-
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)
PacketInMessage
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getBufferId()
org.opendaylight.yangtools.yang.common.Uint64
getCookie()
byte[]
getData()
org.opendaylight.yangtools.yang.common.Uint16
getInPort()
Match
getMatch()
PacketInReason
getReason()
TableId
getTableId()
org.opendaylight.yangtools.yang.common.Uint16
getTotalLen()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
PacketInMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMessage>> augmentationType)
Remove an augmentation from this builder's product.PacketInMessageBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
PacketInMessageBuilder
setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
PacketInMessageBuilder
setData(byte[] value)
PacketInMessageBuilder
setInPort(org.opendaylight.yangtools.yang.common.Uint16 value)
PacketInMessageBuilder
setMatch(Match value)
PacketInMessageBuilder
setReason(PacketInReason value)
PacketInMessageBuilder
setTableId(TableId value)
PacketInMessageBuilder
setTotalLen(org.opendaylight.yangtools.yang.common.Uint16 value)
PacketInMessageBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
PacketInMessageBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
PacketInMessageBuilder
public PacketInMessageBuilder()
-
PacketInMessageBuilder
public PacketInMessageBuilder(PacketIn arg)
-
PacketInMessageBuilder
public PacketInMessageBuilder(OfHeader arg)
-
PacketInMessageBuilder
public PacketInMessageBuilder(MatchGrouping 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:- MatchGrouping
- OfHeader
- PacketIn
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBufferId
public org.opendaylight.yangtools.yang.common.Uint32 getBufferId()
-
getCookie
public org.opendaylight.yangtools.yang.common.Uint64 getCookie()
-
getData
public byte[] getData()
-
getInPort
public org.opendaylight.yangtools.yang.common.Uint16 getInPort()
-
getMatch
public Match getMatch()
-
getReason
public PacketInReason getReason()
-
getTableId
public TableId getTableId()
-
getTotalLen
public org.opendaylight.yangtools.yang.common.Uint16 getTotalLen()
-
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)
-
setBufferId
public PacketInMessageBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setCookie
public PacketInMessageBuilder setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setData
public PacketInMessageBuilder setData(byte[] value)
-
setInPort
public PacketInMessageBuilder setInPort(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMatch
public PacketInMessageBuilder setMatch(Match value)
-
setReason
public PacketInMessageBuilder setReason(PacketInReason value)
-
setTableId
public PacketInMessageBuilder setTableId(TableId value)
-
setTotalLen
public PacketInMessageBuilder setTotalLen(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setVersion
public PacketInMessageBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setXid
public PacketInMessageBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
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 PacketInMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PacketInMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PacketInMessage,IllegalArgumentException>
-
-