Class GetFeaturesOutputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutputBuilder
Class that builds
GetFeaturesOutput
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:
GetFeaturesOutput createGetFeaturesOutput(int fooXyzzy, int barBaz) {
return new GetFeaturesOutputBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of GetFeaturesOutput, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedFeaturesReply
.Construct a builder initialized with state from specifiedGetFeaturesOutput
.Construct a new builder initialized from specifiedOfHeader
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<GetFeaturesOutput> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetFeaturesOutput>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull GetFeaturesOutput
build()
A newGetFeaturesOutput
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toFeaturesReply.getActionsV10()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toFeaturesReply.getAuxiliaryId()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toFeaturesReply.getBuffers()
.Return current value associated with the property corresponding toFeaturesReply.getCapabilities()
.Return current value associated with the property corresponding toFeaturesReply.getCapabilitiesV10()
.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toFeaturesReply.getDatapathId()
.Return current value associated with the property corresponding toFeaturesReply.getPhyPort()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toFeaturesReply.getReserved()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toFeaturesReply.getTables()
.org.opendaylight.yangtools.yang.common.Uint8
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()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetFeaturesOutput>> augmentationType) Remove an augmentation from this builder's product.setActionsV10
(ActionTypeV10 value) Set the property corresponding toFeaturesReply.getActionsV10()
to the specified value.setAuxiliaryId
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toFeaturesReply.getAuxiliaryId()
to the specified value.setBuffers
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toFeaturesReply.getBuffers()
to the specified value.setCapabilities
(Capabilities value) Set the property corresponding toFeaturesReply.getCapabilities()
to the specified value.Set the property corresponding toFeaturesReply.getCapabilitiesV10()
to the specified value.setDatapathId
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toFeaturesReply.getDatapathId()
to the specified value.setPhyPort
(List<PhyPort> values) Set the property corresponding toFeaturesReply.getPhyPort()
to the specified value.setReserved
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toFeaturesReply.getReserved()
to the specified value.setTables
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toFeaturesReply.getTables()
to the specified value.setVersion
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toOfHeader.getVersion()
to the specified value.setXid
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toOfHeader.getXid()
to the specified value.
-
Constructor Details
-
GetFeaturesOutputBuilder
public GetFeaturesOutputBuilder()Construct an empty builder. -
GetFeaturesOutputBuilder
Construct a new builder initialized from specifiedFeaturesReply
.- Parameters:
arg
- FeaturesReply from which the builder should be initialized
-
GetFeaturesOutputBuilder
Construct a new builder initialized from specifiedOfHeader
.- Parameters:
arg
- OfHeader from which the builder should be initialized
-
GetFeaturesOutputBuilder
Construct a builder initialized with state from specifiedGetFeaturesOutput
.- Parameters:
base
- GetFeaturesOutput from which the builder should be initialized
-
-
Method Details
-
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
-
getActionsV10
Return current value associated with the property corresponding toFeaturesReply.getActionsV10()
.- Returns:
- current value
-
getAuxiliaryId
public org.opendaylight.yangtools.yang.common.Uint8 getAuxiliaryId()Return current value associated with the property corresponding toFeaturesReply.getAuxiliaryId()
.- Returns:
- current value
-
getBuffers
public org.opendaylight.yangtools.yang.common.Uint32 getBuffers()Return current value associated with the property corresponding toFeaturesReply.getBuffers()
.- Returns:
- current value
-
getCapabilities
Return current value associated with the property corresponding toFeaturesReply.getCapabilities()
.- Returns:
- current value
-
getCapabilitiesV10
Return current value associated with the property corresponding toFeaturesReply.getCapabilitiesV10()
.- Returns:
- current value
-
getDatapathId
public org.opendaylight.yangtools.yang.common.Uint64 getDatapathId()Return current value associated with the property corresponding toFeaturesReply.getDatapathId()
.- Returns:
- current value
-
getPhyPort
Return current value associated with the property corresponding toFeaturesReply.getPhyPort()
.- Returns:
- current value
-
getReserved
public org.opendaylight.yangtools.yang.common.Uint32 getReserved()Return current value associated with the property corresponding toFeaturesReply.getReserved()
.- Returns:
- current value
-
getTables
public org.opendaylight.yangtools.yang.common.Uint8 getTables()Return current value associated with the property corresponding toFeaturesReply.getTables()
.- 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<GetFeaturesOutput>> 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
-
setActionsV10
Set the property corresponding toFeaturesReply.getActionsV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAuxiliaryId
Set the property corresponding toFeaturesReply.getAuxiliaryId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBuffers
Set the property corresponding toFeaturesReply.getBuffers()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCapabilities
Set the property corresponding toFeaturesReply.getCapabilities()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCapabilitiesV10
Set the property corresponding toFeaturesReply.getCapabilitiesV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDatapathId
Set the property corresponding toFeaturesReply.getDatapathId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPhyPort
Set the property corresponding toFeaturesReply.getPhyPort()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setReserved
Set the property corresponding toFeaturesReply.getReserved()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTables
Set the property corresponding toFeaturesReply.getTables()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
Set the property corresponding toOfHeader.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXid
Set the property corresponding toOfHeader.getXid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public GetFeaturesOutputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GetFeaturesOutput> 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 GetFeaturesOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetFeaturesOutput>> 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
A newGetFeaturesOutput
instance.- Returns:
- A new
GetFeaturesOutput
instance.
-