Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.monitor.configs
Class MonitoringInfoBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.monitor.configs.MonitoringInfoBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MonitoringInfo>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MonitoringInfo,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MonitoringInfoBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<MonitoringInfo>
Class that buildsMonitoringInfoBuilder
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:
MonitoringInfoBuilder createTarget(int fooXyzzy, int barBaz) { return new MonitoringInfoBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MonitoringInfoBuilder, 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:
MonitoringInfoBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MonitoringInfoBuilder()
MonitoringInfoBuilder(MonitoringInfo base)
MonitoringInfoBuilder(MonitorParams arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MonitoringInfoBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringInfo>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringInfo> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringInfo>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
MonitoringInfo
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Destination
getDestination()
org.opendaylight.yangtools.yang.common.Uint32
getId()
MonitoringMode
getMode()
org.opendaylight.yangtools.yang.common.Uint32
getProfileId()
Source
getSource()
MonitoringInfoKey
key()
MonitoringInfoBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringInfo>> augmentationType)
MonitoringInfoBuilder
setDestination(Destination value)
MonitoringInfoBuilder
setId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setId(Uint32)} instead.MonitoringInfoBuilder
setId(org.opendaylight.yangtools.yang.common.Uint32 value)
MonitoringInfoBuilder
setMode(MonitoringMode value)
MonitoringInfoBuilder
setProfileId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setProfileId(Uint32)} instead.MonitoringInfoBuilder
setProfileId(org.opendaylight.yangtools.yang.common.Uint32 value)
MonitoringInfoBuilder
setSource(Source value)
MonitoringInfoBuilder
withKey(MonitoringInfoKey key)
-
-
-
Constructor Detail
-
MonitoringInfoBuilder
public MonitoringInfoBuilder()
-
MonitoringInfoBuilder
public MonitoringInfoBuilder(MonitorParams arg)
-
MonitoringInfoBuilder
public MonitoringInfoBuilder(MonitoringInfo base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.MonitorParams
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
key
public MonitoringInfoKey key()
-
getDestination
public Destination getDestination()
-
getId
public org.opendaylight.yangtools.yang.common.Uint32 getId()
-
getMode
public MonitoringMode getMode()
-
getProfileId
public org.opendaylight.yangtools.yang.common.Uint32 getProfileId()
-
getSource
public Source getSource()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringInfo>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public MonitoringInfoBuilder withKey(MonitoringInfoKey key)
-
setDestination
public MonitoringInfoBuilder setDestination(Destination value)
-
setId
public MonitoringInfoBuilder setId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setId
@Deprecated(forRemoval=true) public MonitoringInfoBuilder setId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setId(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMode
public MonitoringInfoBuilder setMode(MonitoringMode value)
-
setProfileId
public MonitoringInfoBuilder setProfileId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setProfileId
@Deprecated(forRemoval=true) public MonitoringInfoBuilder setProfileId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setProfileId(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setSource
public MonitoringInfoBuilder setSource(Source value)
-
addAugmentation
public MonitoringInfoBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringInfo>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringInfo> augmentationValue)
-
removeAugmentation
public MonitoringInfoBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringInfo>> augmentationType)
-
build
public MonitoringInfo build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MonitoringInfo>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MonitoringInfo,java.lang.IllegalArgumentException>
-
-