Class InterfaceMonitorIdBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._interface.monitor.id.map.InterfaceMonitorIdBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InterfaceMonitorId>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceMonitorId,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class InterfaceMonitorIdBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<InterfaceMonitorId>
Class that buildsInterfaceMonitorIdBuilder
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:
InterfaceMonitorIdBuilder createTarget(int fooXyzzy, int barBaz) { return new InterfaceMonitorIdBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InterfaceMonitorIdBuilder, 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:
InterfaceMonitorIdBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InterfaceMonitorIdBuilder()
InterfaceMonitorIdBuilder(InterfaceMonitorId base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InterfaceMonitorIdBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceMonitorId> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceMonitorId>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
InterfaceMonitorId
build()
java.lang.String
getInterfaceName()
java.util.List<org.opendaylight.yangtools.yang.common.Uint32>
getMonitorId()
InterfaceMonitorIdKey
key()
InterfaceMonitorIdBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceMonitorId>> augmentationType)
Remove an augmentation from this builder's product.InterfaceMonitorIdBuilder
setInterfaceName(java.lang.String value)
InterfaceMonitorIdBuilder
setMonitorId(java.util.List<org.opendaylight.yangtools.yang.common.Uint32> values)
InterfaceMonitorIdBuilder
withKey(InterfaceMonitorIdKey key)
-
-
-
Constructor Detail
-
InterfaceMonitorIdBuilder
public InterfaceMonitorIdBuilder()
-
InterfaceMonitorIdBuilder
public InterfaceMonitorIdBuilder(InterfaceMonitorId base)
-
-
Method Detail
-
key
public InterfaceMonitorIdKey key()
-
getInterfaceName
public java.lang.String getInterfaceName()
-
getMonitorId
public java.util.List<org.opendaylight.yangtools.yang.common.Uint32> getMonitorId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceMonitorId>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public InterfaceMonitorIdBuilder withKey(InterfaceMonitorIdKey key)
-
setInterfaceName
public InterfaceMonitorIdBuilder setInterfaceName(java.lang.String value)
-
setMonitorId
public InterfaceMonitorIdBuilder setMonitorId(java.util.List<org.opendaylight.yangtools.yang.common.Uint32> values)
-
addAugmentation
public InterfaceMonitorIdBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceMonitorId> 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 InterfaceMonitorIdBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceMonitorId>> 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 InterfaceMonitorId build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InterfaceMonitorId>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceMonitorId,java.lang.IllegalArgumentException>
-
-