Class BridgeExternalIdsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIdsBuilder
-
@Generated("mdsal-binding-generator") public class BridgeExternalIdsBuilder extends Object
Class that buildsBridgeExternalIds
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:
BridgeExternalIds createBridgeExternalIds(int fooXyzzy, int barBaz) { return new BridgeExternalIdsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BridgeExternalIds, 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:
BridgeExternalIds
- 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 BridgeExternalIdsBuilder()
Construct an empty builder.BridgeExternalIdsBuilder(BridgeExternalIds base)
Construct a builder initialized with state from specifiedBridgeExternalIds
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BridgeExternalIdsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BridgeExternalIds> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeExternalIds>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BridgeExternalIds
build()
A newBridgeExternalIds
instance.String
getBridgeExternalIdKey()
Return current value associated with the property corresponding toBridgeExternalIds.getBridgeExternalIdKey()
.String
getBridgeExternalIdValue()
Return current value associated with the property corresponding toBridgeExternalIds.getBridgeExternalIdValue()
.BridgeExternalIdsKey
key()
Return current value associated with the property corresponding toBridgeExternalIds.key()
.BridgeExternalIdsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeExternalIds>> augmentationType)
Remove an augmentation from this builder's product.BridgeExternalIdsBuilder
setBridgeExternalIdKey(String value)
Set the property corresponding toBridgeExternalIds.getBridgeExternalIdKey()
to the specified value.BridgeExternalIdsBuilder
setBridgeExternalIdValue(String value)
Set the property corresponding toBridgeExternalIds.getBridgeExternalIdValue()
to the specified value.BridgeExternalIdsBuilder
withKey(BridgeExternalIdsKey key)
-
-
-
Constructor Detail
-
BridgeExternalIdsBuilder
public BridgeExternalIdsBuilder()
Construct an empty builder.
-
BridgeExternalIdsBuilder
public BridgeExternalIdsBuilder(BridgeExternalIds base)
Construct a builder initialized with state from specifiedBridgeExternalIds
.- Parameters:
base
- BridgeExternalIds from which the builder should be initialized
-
-
Method Detail
-
key
public BridgeExternalIdsKey key()
Return current value associated with the property corresponding toBridgeExternalIds.key()
.- Returns:
- current value
-
getBridgeExternalIdKey
public String getBridgeExternalIdKey()
Return current value associated with the property corresponding toBridgeExternalIds.getBridgeExternalIdKey()
.- Returns:
- current value
-
getBridgeExternalIdValue
public String getBridgeExternalIdValue()
Return current value associated with the property corresponding toBridgeExternalIds.getBridgeExternalIdValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeExternalIds>> 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 BridgeExternalIdsBuilder withKey(BridgeExternalIdsKey key)
-
setBridgeExternalIdKey
public BridgeExternalIdsBuilder setBridgeExternalIdKey(String value)
Set the property corresponding toBridgeExternalIds.getBridgeExternalIdKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBridgeExternalIdValue
public BridgeExternalIdsBuilder setBridgeExternalIdValue(String value)
Set the property corresponding toBridgeExternalIds.getBridgeExternalIdValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BridgeExternalIdsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BridgeExternalIds> 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 BridgeExternalIdsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeExternalIds>> 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 BridgeExternalIds build()
A newBridgeExternalIds
instance.- Returns:
- A new
BridgeExternalIds
instance.
-
-