Class PortExternalIdsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortExternalIdsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PortExternalIds>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PortExternalIds,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PortExternalIdsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PortExternalIds>
Class that buildsPortExternalIdsBuilder
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:
PortExternalIdsBuilder createTarget(int fooXyzzy, int barBaz) { return new PortExternalIdsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PortExternalIdsBuilder, 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:
PortExternalIdsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PortExternalIdsBuilder()
PortExternalIdsBuilder(PortExternalIds base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PortExternalIdsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortExternalIds>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PortExternalIds> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.PortExternalIdsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortExternalIds> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortExternalIds>>
E$$augmentation(Class<E$$> augmentationType)
PortExternalIds
build()
String
getExternalIdKey()
String
getExternalIdValue()
PortExternalIdsKey
key()
PortExternalIdsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortExternalIds>> augmentationType)
Remove an augmentation from this builder's product.PortExternalIdsBuilder
setExternalIdKey(String value)
PortExternalIdsBuilder
setExternalIdValue(String value)
PortExternalIdsBuilder
withKey(PortExternalIdsKey key)
-
-
-
Constructor Detail
-
PortExternalIdsBuilder
public PortExternalIdsBuilder()
-
PortExternalIdsBuilder
public PortExternalIdsBuilder(PortExternalIds base)
-
-
Method Detail
-
key
public PortExternalIdsKey key()
-
getExternalIdKey
public String getExternalIdKey()
-
getExternalIdValue
public String getExternalIdValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortExternalIds>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public PortExternalIdsBuilder withKey(PortExternalIdsKey key)
-
setExternalIdKey
public PortExternalIdsBuilder setExternalIdKey(String value)
-
setExternalIdValue
public PortExternalIdsBuilder setExternalIdValue(String value)
-
addAugmentation
public PortExternalIdsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortExternalIds> 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 PortExternalIdsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortExternalIds>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PortExternalIds> 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 PortExternalIdsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortExternalIds>> 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 PortExternalIds build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PortExternalIds>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PortExternalIds,IllegalArgumentException>
-
-