Class UpdatePortInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.port.service.rev131107.UpdatePortInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<UpdatePortInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<UpdatePortInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class UpdatePortInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<UpdatePortInput>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description UpdatePortInputBuilder()
UpdatePortInputBuilder(TransactionAware arg)
UpdatePortInputBuilder(NodeContextRef arg)
UpdatePortInputBuilder(PortUpdate arg)
UpdatePortInputBuilder(UpdatePortInput base)
-
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)
UpdatePortInput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NodeRef
getNode()
OriginalPort
getOriginalPort()
TransactionId
getTransactionId()
UpdatedPort
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)
UpdatePortInputBuilder
setOriginalPort(OriginalPort value)
UpdatePortInputBuilder
setTransactionId(TransactionId value)
UpdatePortInputBuilder
setUpdatedPort(UpdatedPort value)
-
-
-
Constructor Detail
-
UpdatePortInputBuilder
public UpdatePortInputBuilder()
-
UpdatePortInputBuilder
public UpdatePortInputBuilder(PortUpdate arg)
-
UpdatePortInputBuilder
public UpdatePortInputBuilder(NodeContextRef arg)
-
UpdatePortInputBuilder
public UpdatePortInputBuilder(TransactionAware arg)
-
UpdatePortInputBuilder
public UpdatePortInputBuilder(UpdatePortInput 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:- TransactionAware
- NodeContextRef
- PortUpdate
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getNode
public NodeRef getNode()
-
getOriginalPort
public OriginalPort getOriginalPort()
-
getTransactionId
public TransactionId getTransactionId()
-
getUpdatedPort
public UpdatedPort getUpdatedPort()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdatePortInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setNode
public UpdatePortInputBuilder setNode(NodeRef value)
-
setOriginalPort
public UpdatePortInputBuilder setOriginalPort(OriginalPort value)
-
setTransactionId
public UpdatePortInputBuilder setTransactionId(TransactionId value)
-
setUpdatedPort
public UpdatePortInputBuilder setUpdatedPort(UpdatedPort value)
-
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 UpdatePortInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<UpdatePortInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<UpdatePortInput,IllegalArgumentException>
-
-