Class UpdatePortInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.port.service.rev131107.UpdatePortInputBuilder
-
@Generated("mdsal-binding-generator") public class UpdatePortInputBuilder extends Object
Class that buildsUpdatePortInput
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:
UpdatePortInput createUpdatePortInput(int fooXyzzy, int barBaz) { return new UpdatePortInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UpdatePortInput, 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:
UpdatePortInput
- 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 UpdatePortInputBuilder()
Construct an empty builder.UpdatePortInputBuilder(TransactionAware arg)
Construct a new builder initialized from specifiedTransactionAware
.UpdatePortInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.UpdatePortInputBuilder(PortUpdate arg)
Construct a new builder initialized from specifiedPortUpdate
.UpdatePortInputBuilder(UpdatePortInput base)
Construct a builder initialized with state from specifiedUpdatePortInput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UpdatePortInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdatePortInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdatePortInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull UpdatePortInput
build()
A newUpdatePortInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NodeRef
getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.OriginalPort
getOriginalPort()
Return current value associated with the property corresponding toPortUpdate.getOriginalPort()
.TransactionId
getTransactionId()
Return current value associated with the property corresponding toTransactionAware.getTransactionId()
.UpdatedPort
getUpdatedPort()
Return current value associated with the property corresponding toPortUpdate.getUpdatedPort()
.UpdatePortInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdatePortInput>> augmentationType)
Remove an augmentation from this builder's product.UpdatePortInputBuilder
setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.UpdatePortInputBuilder
setOriginalPort(OriginalPort value)
Set the property corresponding toPortUpdate.getOriginalPort()
to the specified value.UpdatePortInputBuilder
setTransactionId(TransactionId value)
Set the property corresponding toTransactionAware.getTransactionId()
to the specified value.UpdatePortInputBuilder
setUpdatedPort(UpdatedPort value)
Set the property corresponding toPortUpdate.getUpdatedPort()
to the specified value.
-
-
-
Constructor Detail
-
UpdatePortInputBuilder
public UpdatePortInputBuilder()
Construct an empty builder.
-
UpdatePortInputBuilder
public UpdatePortInputBuilder(PortUpdate arg)
Construct a new builder initialized from specifiedPortUpdate
.- Parameters:
arg
- PortUpdate from which the builder should be initialized
-
UpdatePortInputBuilder
public UpdatePortInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.- Parameters:
arg
- NodeContextRef from which the builder should be initialized
-
UpdatePortInputBuilder
public UpdatePortInputBuilder(TransactionAware arg)
Construct a new builder initialized from specifiedTransactionAware
.- Parameters:
arg
- TransactionAware from which the builder should be initialized
-
UpdatePortInputBuilder
public UpdatePortInputBuilder(UpdatePortInput base)
Construct a builder initialized with state from specifiedUpdatePortInput
.- Parameters:
base
- UpdatePortInput 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
-
getNode
public NodeRef getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.- Returns:
- current value
-
getOriginalPort
public OriginalPort getOriginalPort()
Return current value associated with the property corresponding toPortUpdate.getOriginalPort()
.- Returns:
- current value
-
getTransactionId
public TransactionId getTransactionId()
Return current value associated with the property corresponding toTransactionAware.getTransactionId()
.- Returns:
- current value
-
getUpdatedPort
public UpdatedPort getUpdatedPort()
Return current value associated with the property corresponding toPortUpdate.getUpdatedPort()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdatePortInput>> 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
-
setNode
public UpdatePortInputBuilder setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOriginalPort
public UpdatePortInputBuilder setOriginalPort(OriginalPort value)
Set the property corresponding toPortUpdate.getOriginalPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransactionId
public UpdatePortInputBuilder setTransactionId(TransactionId value)
Set the property corresponding toTransactionAware.getTransactionId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setUpdatedPort
public UpdatePortInputBuilder setUpdatedPort(UpdatedPort value)
Set the property corresponding toPortUpdate.getUpdatedPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public UpdatePortInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdatePortInput> 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 UpdatePortInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdatePortInput>> 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 UpdatePortInput build()
A newUpdatePortInput
instance.- Returns:
- A new
UpdatePortInput
instance.
-
-