Class BmpMonitorConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.config.rev200120.odl.bmp.monitors.BmpMonitorConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BmpMonitorConfig>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BmpMonitorConfig,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BmpMonitorConfigBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BmpMonitorConfig>
Class that buildsBmpMonitorConfigBuilder
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:
BmpMonitorConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new BmpMonitorConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BmpMonitorConfigBuilder, 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:
BmpMonitorConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BmpMonitorConfigBuilder()
BmpMonitorConfigBuilder(BmpMonitorConfig base)
BmpMonitorConfigBuilder(ServerConfig arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BmpMonitorConfigBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BmpMonitorConfig> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BmpMonitorConfig>>
E$$augmentation(Class<E$$> augmentationType)
BmpMonitorConfig
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<MonitoredRouterKey,MonitoredRouter>
getMonitoredRouter()
MonitorId
getMonitorId()
Server
getServer()
BmpMonitorConfigKey
key()
BmpMonitorConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BmpMonitorConfig>> augmentationType)
Remove an augmentation from this builder's product.BmpMonitorConfigBuilder
setMonitoredRouter(List<MonitoredRouter> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMonitoredRouter(Map)
instead.BmpMonitorConfigBuilder
setMonitoredRouter(Map<MonitoredRouterKey,MonitoredRouter> values)
BmpMonitorConfigBuilder
setMonitorId(MonitorId value)
BmpMonitorConfigBuilder
setServer(Server value)
BmpMonitorConfigBuilder
withKey(BmpMonitorConfigKey key)
-
-
-
Constructor Detail
-
BmpMonitorConfigBuilder
public BmpMonitorConfigBuilder()
-
BmpMonitorConfigBuilder
public BmpMonitorConfigBuilder(ServerConfig arg)
-
BmpMonitorConfigBuilder
public BmpMonitorConfigBuilder(BmpMonitorConfig 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.params.xml.ns.yang.bmp.monitor.config.rev200120.ServerConfig
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public BmpMonitorConfigKey key()
-
getMonitorId
public MonitorId getMonitorId()
-
getMonitoredRouter
public Map<MonitoredRouterKey,MonitoredRouter> getMonitoredRouter()
-
getServer
public Server getServer()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BmpMonitorConfig>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BmpMonitorConfigBuilder withKey(BmpMonitorConfigKey key)
-
setMonitorId
public BmpMonitorConfigBuilder setMonitorId(MonitorId value)
-
setMonitoredRouter
public BmpMonitorConfigBuilder setMonitoredRouter(Map<MonitoredRouterKey,MonitoredRouter> values)
-
setMonitoredRouter
@Deprecated(forRemoval=true) public BmpMonitorConfigBuilder setMonitoredRouter(List<MonitoredRouter> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMonitoredRouter(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
setServer
public BmpMonitorConfigBuilder setServer(Server value)
-
addAugmentation
public BmpMonitorConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BmpMonitorConfig> 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 BmpMonitorConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BmpMonitorConfig>> 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 BmpMonitorConfig build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BmpMonitorConfig>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BmpMonitorConfig,IllegalArgumentException>
-
-