Class InterfaceExternalIdsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceExternalIdsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InterfaceExternalIds>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceExternalIds,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class InterfaceExternalIdsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<InterfaceExternalIds>
Class that buildsInterfaceExternalIdsBuilder
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:
InterfaceExternalIdsBuilder createTarget(int fooXyzzy, int barBaz) { return new InterfaceExternalIdsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InterfaceExternalIdsBuilder, 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:
InterfaceExternalIdsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InterfaceExternalIdsBuilder()
InterfaceExternalIdsBuilder(InterfaceExternalIds base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InterfaceExternalIdsBuilder
addAugmentation(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)
InterfaceExternalIds
build()
String
getExternalIdKey()
String
getExternalIdValue()
InterfaceExternalIdsKey
key()
InterfaceExternalIdsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceExternalIds>> augmentationType)
Remove an augmentation from this builder's product.InterfaceExternalIdsBuilder
setExternalIdKey(String value)
InterfaceExternalIdsBuilder
setExternalIdValue(String value)
InterfaceExternalIdsBuilder
withKey(InterfaceExternalIdsKey key)
-
-
-
Constructor Detail
-
InterfaceExternalIdsBuilder
public InterfaceExternalIdsBuilder()
-
InterfaceExternalIdsBuilder
public InterfaceExternalIdsBuilder(InterfaceExternalIds base)
-
-
Method Detail
-
key
public InterfaceExternalIdsKey key()
-
getExternalIdKey
public String getExternalIdKey()
-
getExternalIdValue
public String getExternalIdValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceExternalIds>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public InterfaceExternalIdsBuilder withKey(InterfaceExternalIdsKey key)
-
setExternalIdKey
public InterfaceExternalIdsBuilder setExternalIdKey(String value)
-
setExternalIdValue
public InterfaceExternalIdsBuilder setExternalIdValue(String value)
-
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
public InterfaceExternalIds build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InterfaceExternalIds>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceExternalIds,IllegalArgumentException>
-
-