Class PortUpdatedBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.port.service.rev131107.PortUpdatedBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PortUpdated>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PortUpdated,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PortUpdatedBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PortUpdated>
Class that buildsPortUpdatedBuilder
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:
PortUpdatedBuilder createTarget(int fooXyzzy, int barBaz) { return new PortUpdatedBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PortUpdatedBuilder, 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 oportunities, 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:
PortUpdatedBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PortUpdatedBuilder()
PortUpdatedBuilder(TransactionAware arg)
PortUpdatedBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
PortUpdatedBuilder(PortUpdate arg)
PortUpdatedBuilder(PortUpdated base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PortUpdatedBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortUpdated>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PortUpdated> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.PortUpdatedBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortUpdated> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortUpdated>>
E$$augmentation(Class<E$$> augmentationType)
PortUpdated
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef
getNode()
OriginalPort
getOriginalPort()
TransactionId
getTransactionId()
UpdatedPort
getUpdatedPort()
PortUpdatedBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortUpdated>> augmentationType)
Remove an augmentation from this builder's product.PortUpdatedBuilder
setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
PortUpdatedBuilder
setOriginalPort(OriginalPort value)
PortUpdatedBuilder
setTransactionId(TransactionId value)
PortUpdatedBuilder
setUpdatedPort(UpdatedPort value)
-
-
-
Constructor Detail
-
PortUpdatedBuilder
public PortUpdatedBuilder()
-
PortUpdatedBuilder
public PortUpdatedBuilder(PortUpdate arg)
-
PortUpdatedBuilder
public PortUpdatedBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
-
PortUpdatedBuilder
public PortUpdatedBuilder(TransactionAware arg)
-
PortUpdatedBuilder
public PortUpdatedBuilder(PortUpdated 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionAware
- org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef
- org.opendaylight.yang.gen.v1.urn.opendaylight.port.service.rev131107.PortUpdate
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getNode
public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef getNode()
-
getOriginalPort
public OriginalPort getOriginalPort()
-
getTransactionId
public TransactionId getTransactionId()
-
getUpdatedPort
public UpdatedPort getUpdatedPort()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortUpdated>> E$$ augmentation(Class<E$$> augmentationType)
-
setNode
public PortUpdatedBuilder setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
-
setOriginalPort
public PortUpdatedBuilder setOriginalPort(OriginalPort value)
-
setTransactionId
public PortUpdatedBuilder setTransactionId(TransactionId value)
-
setUpdatedPort
public PortUpdatedBuilder setUpdatedPort(UpdatedPort value)
-
addAugmentation
public PortUpdatedBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortUpdated> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public PortUpdatedBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortUpdated>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PortUpdated> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public PortUpdatedBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortUpdated>> 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 PortUpdated build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PortUpdated>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PortUpdated,IllegalArgumentException>
-
-