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