Class PortExternalIdsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortExternalIdsBuilder
-
@Generated("mdsal-binding-generator") public class PortExternalIdsBuilder extends Object
Class that buildsPortExternalIds
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:
PortExternalIds createPortExternalIds(int fooXyzzy, int barBaz) { return new PortExternalIdsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PortExternalIds, 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:
PortExternalIds
- 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 PortExternalIdsBuilder()
Construct an empty builder.PortExternalIdsBuilder(PortExternalIds base)
Construct a builder initialized with state from specifiedPortExternalIds
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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)
Return the specified augmentation, if it is present in this builder.@NonNull PortExternalIds
build()
A newPortExternalIds
instance.String
getExternalIdKey()
Return current value associated with the property corresponding toPortExternalIds.getExternalIdKey()
.String
getExternalIdValue()
Return current value associated with the property corresponding toPortExternalIds.getExternalIdValue()
.PortExternalIdsKey
key()
Return current value associated with the property corresponding toPortExternalIds.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)
Set the property corresponding toPortExternalIds.getExternalIdKey()
to the specified value.PortExternalIdsBuilder
setExternalIdValue(String value)
Set the property corresponding toPortExternalIds.getExternalIdValue()
to the specified value.PortExternalIdsBuilder
withKey(PortExternalIdsKey key)
-
-
-
Constructor Detail
-
PortExternalIdsBuilder
public PortExternalIdsBuilder()
Construct an empty builder.
-
PortExternalIdsBuilder
public PortExternalIdsBuilder(PortExternalIds base)
Construct a builder initialized with state from specifiedPortExternalIds
.- Parameters:
base
- PortExternalIds from which the builder should be initialized
-
-
Method Detail
-
key
public PortExternalIdsKey key()
Return current value associated with the property corresponding toPortExternalIds.key()
.- Returns:
- current value
-
getExternalIdKey
public String getExternalIdKey()
Return current value associated with the property corresponding toPortExternalIds.getExternalIdKey()
.- Returns:
- current value
-
getExternalIdValue
public String getExternalIdValue()
Return current value associated with the property corresponding toPortExternalIds.getExternalIdValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortExternalIds>> 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
-
withKey
public PortExternalIdsBuilder withKey(PortExternalIdsKey key)
-
setExternalIdKey
public PortExternalIdsBuilder setExternalIdKey(String value)
Set the property corresponding toPortExternalIds.getExternalIdKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setExternalIdValue
public PortExternalIdsBuilder setExternalIdValue(String value)
Set the property corresponding toPortExternalIds.getExternalIdValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
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 @NonNull PortExternalIds build()
A newPortExternalIds
instance.- Returns:
- A new
PortExternalIds
instance.
-
-