Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.monitorid.key.map
Class MonitoridKeyEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.monitorid.key.map.MonitoridKeyEntryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MonitoridKeyEntry>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MonitoridKeyEntry,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MonitoridKeyEntryBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<MonitoridKeyEntry>
Class that buildsMonitoridKeyEntryBuilder
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:
MonitoridKeyEntryBuilder createTarget(int fooXyzzy, int barBaz) { return new MonitoridKeyEntryBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MonitoridKeyEntryBuilder, 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:
MonitoridKeyEntryBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MonitoridKeyEntryBuilder()
MonitoridKeyEntryBuilder(MonitoridKeyEntry base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MonitoridKeyEntryBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoridKeyEntry>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MonitoridKeyEntry> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.MonitoridKeyEntryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MonitoridKeyEntry> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoridKeyEntry>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
MonitoridKeyEntry
build()
org.opendaylight.yangtools.yang.common.Uint32
getMonitorId()
java.lang.String
getMonitorKey()
MonitoridKeyEntryKey
key()
MonitoridKeyEntryBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoridKeyEntry>> augmentationType)
Remove an augmentation from this builder's product.MonitoridKeyEntryBuilder
setMonitorId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMonitorId(Uint32)
instead.MonitoridKeyEntryBuilder
setMonitorId(org.opendaylight.yangtools.yang.common.Uint32 value)
MonitoridKeyEntryBuilder
setMonitorKey(java.lang.String value)
MonitoridKeyEntryBuilder
withKey(MonitoridKeyEntryKey key)
-
-
-
Constructor Detail
-
MonitoridKeyEntryBuilder
public MonitoridKeyEntryBuilder()
-
MonitoridKeyEntryBuilder
public MonitoridKeyEntryBuilder(MonitoridKeyEntry base)
-
-
Method Detail
-
key
public MonitoridKeyEntryKey key()
-
getMonitorId
public org.opendaylight.yangtools.yang.common.Uint32 getMonitorId()
-
getMonitorKey
public java.lang.String getMonitorKey()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoridKeyEntry>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public MonitoridKeyEntryBuilder withKey(MonitoridKeyEntryKey key)
-
setMonitorId
public MonitoridKeyEntryBuilder setMonitorId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMonitorId
@Deprecated(forRemoval=true) public MonitoridKeyEntryBuilder setMonitorId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMonitorId(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMonitorKey
public MonitoridKeyEntryBuilder setMonitorKey(java.lang.String value)
-
addAugmentation
public MonitoridKeyEntryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MonitoridKeyEntry> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public MonitoridKeyEntryBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoridKeyEntry>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MonitoridKeyEntry> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public MonitoridKeyEntryBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoridKeyEntry>> 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 MonitoridKeyEntry build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MonitoridKeyEntry>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MonitoridKeyEntry,java.lang.IllegalArgumentException>
-
-