Class InterfaceExternalIdsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceExternalIdsBuilder
Class that builds
InterfaceExternalIds
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:
InterfaceExternalIds createInterfaceExternalIds(int fooXyzzy, int barBaz) {
return new InterfaceExternalIdsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of InterfaceExternalIds, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedInterfaceExternalIds
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceExternalIds> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceExternalIds>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull InterfaceExternalIds
build()
A newInterfaceExternalIds
instance.Return current value associated with the property corresponding toInterfaceExternalIds.getExternalIdKey()
.Return current value associated with the property corresponding toInterfaceExternalIds.getExternalIdValue()
.key()
Return current value associated with the property corresponding toInterfaceExternalIds.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceExternalIds>> augmentationType) Remove an augmentation from this builder's product.setExternalIdKey
(String value) Set the property corresponding toInterfaceExternalIds.getExternalIdKey()
to the specified value.setExternalIdValue
(String value) Set the property corresponding toInterfaceExternalIds.getExternalIdValue()
to the specified value.Set the key value corresponding toInterfaceExternalIds.key()
to the specified value.
-
Constructor Details
-
InterfaceExternalIdsBuilder
public InterfaceExternalIdsBuilder()Construct an empty builder. -
InterfaceExternalIdsBuilder
Construct a builder initialized with state from specifiedInterfaceExternalIds
.- Parameters:
base
- InterfaceExternalIds from which the builder should be initialized
-
-
Method Details
-
key
Return current value associated with the property corresponding toInterfaceExternalIds.key()
.- Returns:
- current value
-
getExternalIdKey
Return current value associated with the property corresponding toInterfaceExternalIds.getExternalIdKey()
.- Returns:
- current value
-
getExternalIdValue
Return current value associated with the property corresponding toInterfaceExternalIds.getExternalIdValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceExternalIds>> 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
Set the key value corresponding toInterfaceExternalIds.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setExternalIdKey
Set the property corresponding toInterfaceExternalIds.getExternalIdKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setExternalIdValue
Set the property corresponding toInterfaceExternalIds.getExternalIdValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public InterfaceExternalIdsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceExternalIds> 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 InterfaceExternalIdsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceExternalIds>> 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
A newInterfaceExternalIds
instance.- Returns:
- A new
InterfaceExternalIds
instance.
-