Class MonitorIdInterfaceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.monitor.id._interface.map.MonitorIdInterfaceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MonitorIdInterface>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MonitorIdInterface,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MonitorIdInterfaceBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<MonitorIdInterface>
Class that buildsMonitorIdInterfaceBuilder
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:
MonitorIdInterfaceBuilder createTarget(int fooXyzzy, int barBaz) { return new MonitorIdInterfaceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MonitorIdInterfaceBuilder, 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:
MonitorIdInterfaceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MonitorIdInterfaceBuilder()
MonitorIdInterfaceBuilder(MonitorIdInterface base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MonitorIdInterfaceBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitorIdInterface>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MonitorIdInterface> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.MonitorIdInterfaceBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MonitorIdInterface> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitorIdInterface>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
MonitorIdInterface
build()
java.lang.String
getInterfaceName()
org.opendaylight.yangtools.yang.common.Uint32
getMonitorId()
MonitorIdInterfaceKey
key()
MonitorIdInterfaceBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitorIdInterface>> augmentationType)
Remove an augmentation from this builder's product.MonitorIdInterfaceBuilder
setInterfaceName(java.lang.String value)
MonitorIdInterfaceBuilder
setMonitorId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMonitorId(Uint32)
instead.MonitorIdInterfaceBuilder
setMonitorId(org.opendaylight.yangtools.yang.common.Uint32 value)
MonitorIdInterfaceBuilder
withKey(MonitorIdInterfaceKey key)
-
-
-
Constructor Detail
-
MonitorIdInterfaceBuilder
public MonitorIdInterfaceBuilder()
-
MonitorIdInterfaceBuilder
public MonitorIdInterfaceBuilder(MonitorIdInterface base)
-
-
Method Detail
-
key
public MonitorIdInterfaceKey key()
-
getInterfaceName
public java.lang.String getInterfaceName()
-
getMonitorId
public org.opendaylight.yangtools.yang.common.Uint32 getMonitorId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitorIdInterface>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public MonitorIdInterfaceBuilder withKey(MonitorIdInterfaceKey key)
-
setInterfaceName
public MonitorIdInterfaceBuilder setInterfaceName(java.lang.String value)
-
setMonitorId
public MonitorIdInterfaceBuilder setMonitorId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMonitorId
@Deprecated(forRemoval=true) public MonitorIdInterfaceBuilder 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
-
addAugmentation
public MonitorIdInterfaceBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MonitorIdInterface> 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 MonitorIdInterfaceBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitorIdInterface>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MonitorIdInterface> 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 MonitorIdInterfaceBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitorIdInterface>> 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 MonitorIdInterface build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MonitorIdInterface>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MonitorIdInterface,java.lang.IllegalArgumentException>
-
-