Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.bmp.monitor
Class MonitorBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.bmp.monitor.MonitorBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Monitor>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Monitor,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MonitorBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Monitor>
Class that buildsMonitor
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:
Monitor createMonitor(int fooXyzzy, int barBaz) { return new MonitorBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Monitor, 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 opportunities, 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:
Monitor
,Builder
-
-
Constructor Summary
Constructors Constructor Description MonitorBuilder()
MonitorBuilder(Monitor base)
MonitorBuilder(Routers arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MonitorBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Monitor> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Monitor>>
E$$augmentation(Class<E$$> augmentationType)
Monitor
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MonitorId
getMonitorId()
Map<RouterKey,Router>
getRouter()
MonitorKey
key()
MonitorBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Monitor>> augmentationType)
Remove an augmentation from this builder's product.MonitorBuilder
setMonitorId(MonitorId value)
MonitorBuilder
setRouter(Map<RouterKey,Router> values)
MonitorBuilder
withKey(MonitorKey key)
-
-
-
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:- Routers
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public MonitorKey key()
-
getMonitorId
public MonitorId getMonitorId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Monitor>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public MonitorBuilder withKey(MonitorKey key)
-
setMonitorId
public MonitorBuilder setMonitorId(MonitorId value)
-
setRouter
public MonitorBuilder setRouter(Map<RouterKey,Router> values)
-
addAugmentation
public MonitorBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Monitor> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public MonitorBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Monitor>> 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 Monitor build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Monitor>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Monitor,IllegalArgumentException>
-
-