Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.monitor.start.input
Class ConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.monitor.start.input.ConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Config>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Config,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ConfigBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Config>
Class that buildsConfigBuilder
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:
ConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new ConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ConfigBuilder, 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:
ConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ConfigBuilder()
ConfigBuilder(Config base)
ConfigBuilder(MonitorParams arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ConfigBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Config> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Config
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Destination
getDestination()
MonitoringMode
getMode()
org.opendaylight.yangtools.yang.common.Uint32
getProfileId()
Source
getSource()
ConfigBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType)
ConfigBuilder
setDestination(Destination value)
ConfigBuilder
setMode(MonitoringMode value)
ConfigBuilder
setProfileId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setProfileId(Uint32)} instead.ConfigBuilder
setProfileId(org.opendaylight.yangtools.yang.common.Uint32 value)
ConfigBuilder
setSource(Source value)
-
-
-
Constructor Detail
-
ConfigBuilder
public ConfigBuilder()
-
ConfigBuilder
public ConfigBuilder(MonitorParams arg)
-
ConfigBuilder
public ConfigBuilder(Config 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
-
getDestination
public Destination getDestination()
-
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<Config>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setDestination
public ConfigBuilder setDestination(Destination value)
-
setMode
public ConfigBuilder setMode(MonitoringMode value)
-
setProfileId
public ConfigBuilder setProfileId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setProfileId
@Deprecated(forRemoval=true) public ConfigBuilder 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 ConfigBuilder setSource(Source value)
-
addAugmentation
public ConfigBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Config> augmentationValue)
-
removeAugmentation
public ConfigBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType)
-
-