Class TunnelMonitorParamsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.TunnelMonitorParamsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TunnelMonitorParams>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TunnelMonitorParams,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TunnelMonitorParamsBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<TunnelMonitorParams>
Class that buildsTunnelMonitorParamsBuilder
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:
TunnelMonitorParamsBuilder createTarget(int fooXyzzy, int barBaz) { return new TunnelMonitorParamsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TunnelMonitorParamsBuilder, 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:
TunnelMonitorParamsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TunnelMonitorParamsBuilder()
TunnelMonitorParamsBuilder(TunnelMonitorParams base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TunnelMonitorParamsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunnelMonitorParams> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelMonitorParams>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
TunnelMonitorParams
build()
java.lang.Boolean
getEnabled()
java.lang.Class<? extends TunnelMonitoringTypeBase>
getMonitorProtocol()
java.lang.Boolean
isEnabled()
Deprecated, for removal: This API element is subject to removal in a future version.TunnelMonitorParamsBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelMonitorParams>> augmentationType)
Remove an augmentation from this builder's product.TunnelMonitorParamsBuilder
setEnabled(java.lang.Boolean value)
TunnelMonitorParamsBuilder
setMonitorProtocol(java.lang.Class<? extends TunnelMonitoringTypeBase> value)
-
-
-
Constructor Detail
-
TunnelMonitorParamsBuilder
public TunnelMonitorParamsBuilder()
-
TunnelMonitorParamsBuilder
public TunnelMonitorParamsBuilder(TunnelMonitorParams base)
-
-
Method Detail
-
getEnabled
public java.lang.Boolean getEnabled()
-
isEnabled
@Deprecated(forRemoval=true) public final java.lang.Boolean isEnabled()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getMonitorProtocol
public java.lang.Class<? extends TunnelMonitoringTypeBase> getMonitorProtocol()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelMonitorParams>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setEnabled
public TunnelMonitorParamsBuilder setEnabled(java.lang.Boolean value)
-
setMonitorProtocol
public TunnelMonitorParamsBuilder setMonitorProtocol(java.lang.Class<? extends TunnelMonitoringTypeBase> value)
-
addAugmentation
public TunnelMonitorParamsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunnelMonitorParams> 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
-
removeAugmentation
public TunnelMonitorParamsBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelMonitorParams>> 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 TunnelMonitorParams build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TunnelMonitorParams>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TunnelMonitorParams,java.lang.IllegalArgumentException>
-
-