Class QosEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.QosEntryBuilder
-
@Generated("mdsal-binding-generator") public class QosEntryBuilder extends Object
Class that buildsQosEntry
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:
QosEntry createQosEntry(int fooXyzzy, int barBaz) { return new QosEntryBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of QosEntry, 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:
QosEntry
- 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 QosEntryBuilder()
Construct an empty builder.QosEntryBuilder(QosEntry base)
Construct a builder initialized with state from specifiedQosEntry
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description QosEntryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<QosEntry> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<QosEntry>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull QosEntry
build()
A newQosEntry
instance.org.opendaylight.yangtools.yang.common.Uint32
getQosKey()
Return current value associated with the property corresponding toQosEntry.getQosKey()
.OvsdbQosRef
getQosRef()
Return current value associated with the property corresponding toQosEntry.getQosRef()
.QosEntryKey
key()
Return current value associated with the property corresponding toQosEntry.key()
.QosEntryBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<QosEntry>> augmentationType)
Remove an augmentation from this builder's product.QosEntryBuilder
setQosKey(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toQosEntry.getQosKey()
to the specified value.QosEntryBuilder
setQosRef(OvsdbQosRef value)
Set the property corresponding toQosEntry.getQosRef()
to the specified value.QosEntryBuilder
withKey(QosEntryKey key)
-
-
-
Method Detail
-
key
public QosEntryKey key()
Return current value associated with the property corresponding toQosEntry.key()
.- Returns:
- current value
-
getQosKey
public org.opendaylight.yangtools.yang.common.Uint32 getQosKey()
Return current value associated with the property corresponding toQosEntry.getQosKey()
.- Returns:
- current value
-
getQosRef
public OvsdbQosRef getQosRef()
Return current value associated with the property corresponding toQosEntry.getQosRef()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<QosEntry>> 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 QosEntryBuilder withKey(QosEntryKey key)
-
setQosKey
public QosEntryBuilder setQosKey(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toQosEntry.getQosKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setQosRef
public QosEntryBuilder setQosRef(OvsdbQosRef value)
Set the property corresponding toQosEntry.getQosRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public QosEntryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<QosEntry> 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 QosEntryBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<QosEntry>> 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
-
-