Class PacketOutInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketOutInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PacketOutInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PacketOutInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PacketOutInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PacketOutInput>
Class that buildsPacketOutInput
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:
PacketOutInput createPacketOutInput(int fooXyzzy, int barBaz) { return new PacketOutInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PacketOutInput, 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:
PacketOutInput
,Builder
-
-
Constructor Summary
Constructors Constructor Description PacketOutInputBuilder()
PacketOutInputBuilder(ActionsGrouping arg)
PacketOutInputBuilder(OfHeader arg)
PacketOutInputBuilder(PacketOut$G arg)
PacketOutInputBuilder(PacketOutInput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PacketOutInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketOutInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketOutInput>>
E$$augmentation(Class<E$$> augmentationType)
PacketOutInput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Action>
getAction()
org.opendaylight.yangtools.yang.common.Uint32
getBufferId()
byte[]
getData()
PortNumber
getInPort()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
PacketOutInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketOutInput>> augmentationType)
Remove an augmentation from this builder's product.PacketOutInputBuilder
setAction(List<Action> values)
PacketOutInputBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
PacketOutInputBuilder
setData(byte[] value)
PacketOutInputBuilder
setInPort(PortNumber value)
PacketOutInputBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
PacketOutInputBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
PacketOutInputBuilder
public PacketOutInputBuilder()
-
PacketOutInputBuilder
public PacketOutInputBuilder(PacketOut$G arg)
-
PacketOutInputBuilder
public PacketOutInputBuilder(OfHeader arg)
-
PacketOutInputBuilder
public PacketOutInputBuilder(ActionsGrouping arg)
-
PacketOutInputBuilder
public PacketOutInputBuilder(PacketOutInput 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:- ActionsGrouping
- OfHeader
- PacketOut$G
- 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()
-
getData
public byte[] getData()
-
getInPort
public PortNumber getInPort()
-
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<PacketOutInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setAction
public PacketOutInputBuilder setAction(List<Action> values)
-
setBufferId
public PacketOutInputBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setData
public PacketOutInputBuilder setData(byte[] value)
-
setInPort
public PacketOutInputBuilder setInPort(PortNumber value)
-
setVersion
public PacketOutInputBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setXid
public PacketOutInputBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
addAugmentation
public PacketOutInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketOutInput> 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 PacketOutInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketOutInput>> 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 PacketOutInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PacketOutInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PacketOutInput,IllegalArgumentException>
-
-