Class UpdateFlowInputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowInputBuilder
Class that builds
UpdateFlowInput
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:
UpdateFlowInput createUpdateFlowInput(int fooXyzzy, int barBaz) {
return new UpdateFlowInputBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of UpdateFlowInput, 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 specifiedFlowUpdate
.Construct a builder initialized with state from specifiedUpdateFlowInput
.Construct a new builder initialized from specifiedTransactionMetadata
.Construct a new builder initialized from specifiedNodeContextRef
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowInput> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowInput>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull UpdateFlowInput
build()
A newUpdateFlowInput
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toUpdateFlowInput.getFlowRef()
.getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.Return current value associated with the property corresponding toFlowUpdate.getOriginalFlow()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
Return current value associated with the property corresponding toTransactionMetadata.getTransactionUri()
.Return current value associated with the property corresponding toFlowUpdate.getUpdatedFlow()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowInput>> augmentationType) Remove an augmentation from this builder's product.setFlowRef
(FlowRef value) Set the property corresponding toUpdateFlowInput.getFlowRef()
to the specified value.Set the property corresponding toNodeContextRef.getNode()
to the specified value.setOriginalFlow
(OriginalFlow value) Set the property corresponding toFlowUpdate.getOriginalFlow()
to the specified value.setTransactionUri
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value) Set the property corresponding toTransactionMetadata.getTransactionUri()
to the specified value.setUpdatedFlow
(UpdatedFlow value) Set the property corresponding toFlowUpdate.getUpdatedFlow()
to the specified value.
-
Constructor Details
-
UpdateFlowInputBuilder
public UpdateFlowInputBuilder()Construct an empty builder. -
UpdateFlowInputBuilder
Construct a new builder initialized from specifiedTransactionMetadata
.- Parameters:
arg
- TransactionMetadata from which the builder should be initialized
-
UpdateFlowInputBuilder
Construct a new builder initialized from specifiedFlowUpdate
.- Parameters:
arg
- FlowUpdate from which the builder should be initialized
-
UpdateFlowInputBuilder
Construct a new builder initialized from specifiedNodeContextRef
.- Parameters:
arg
- NodeContextRef from which the builder should be initialized
-
UpdateFlowInputBuilder
Construct a builder initialized with state from specifiedUpdateFlowInput
.- Parameters:
base
- UpdateFlowInput 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
-
getFlowRef
Return current value associated with the property corresponding toUpdateFlowInput.getFlowRef()
.- Returns:
- current value
-
getNode
Return current value associated with the property corresponding toNodeContextRef.getNode()
.- Returns:
- current value
-
getOriginalFlow
Return current value associated with the property corresponding toFlowUpdate.getOriginalFlow()
.- Returns:
- current value
-
getTransactionUri
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()Return current value associated with the property corresponding toTransactionMetadata.getTransactionUri()
.- Returns:
- current value
-
getUpdatedFlow
Return current value associated with the property corresponding toFlowUpdate.getUpdatedFlow()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowInput>> 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
-
setFlowRef
Set the property corresponding toUpdateFlowInput.getFlowRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
Set the property corresponding toNodeContextRef.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOriginalFlow
Set the property corresponding toFlowUpdate.getOriginalFlow()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransactionUri
public UpdateFlowInputBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value) Set the property corresponding toTransactionMetadata.getTransactionUri()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setUpdatedFlow
Set the property corresponding toFlowUpdate.getUpdatedFlow()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public UpdateFlowInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowInput> 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 UpdateFlowInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowInput>> 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 newUpdateFlowInput
instance.- Returns:
- A new
UpdateFlowInput
instance.
-