Class BmpMonitorConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.config.rev200120.odl.bmp.monitors.BmpMonitorConfigBuilder
-
@Generated("mdsal-binding-generator") public class BmpMonitorConfigBuilder extends Object
Class that buildsBmpMonitorConfig
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:
BmpMonitorConfig createBmpMonitorConfig(int fooXyzzy, int barBaz) { return new BmpMonitorConfigBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BmpMonitorConfig, 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:
BmpMonitorConfig
- 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
-
-
Constructor Summary
Constructors Constructor Description BmpMonitorConfigBuilder()
Construct an empty builder.BmpMonitorConfigBuilder(BmpMonitorConfig base)
Construct a builder initialized with state from specifiedBmpMonitorConfig
.BmpMonitorConfigBuilder(ServerConfig arg)
Construct a new builder initialized from specifiedServerConfig
.
-
Method Summary
All Methods Instance Methods Concrete 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)
Return the specified augmentation, if it is present in this builder.@NonNull BmpMonitorConfig
build()
A newBmpMonitorConfig
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<MonitoredRouterKey,MonitoredRouter>
getMonitoredRouter()
Return current value associated with the property corresponding toBmpMonitorConfig.getMonitoredRouter()
.MonitorId
getMonitorId()
Return current value associated with the property corresponding toBmpMonitorConfig.getMonitorId()
.Server
getServer()
Return current value associated with the property corresponding toServerConfig.getServer()
.BmpMonitorConfigKey
key()
Return current value associated with the property corresponding toBmpMonitorConfig.key()
.BmpMonitorConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BmpMonitorConfig>> augmentationType)
Remove an augmentation from this builder's product.BmpMonitorConfigBuilder
setMonitoredRouter(Map<MonitoredRouterKey,MonitoredRouter> values)
Set the property corresponding toBmpMonitorConfig.getMonitoredRouter()
to the specified value.BmpMonitorConfigBuilder
setMonitorId(MonitorId value)
Set the property corresponding toBmpMonitorConfig.getMonitorId()
to the specified value.BmpMonitorConfigBuilder
setServer(Server value)
Set the property corresponding toServerConfig.getServer()
to the specified value.BmpMonitorConfigBuilder
withKey(BmpMonitorConfigKey key)
-
-
-
Constructor Detail
-
BmpMonitorConfigBuilder
public BmpMonitorConfigBuilder()
Construct an empty builder.
-
BmpMonitorConfigBuilder
public BmpMonitorConfigBuilder(ServerConfig arg)
Construct a new builder initialized from specifiedServerConfig
.- Parameters:
arg
- ServerConfig from which the builder should be initialized
-
BmpMonitorConfigBuilder
public BmpMonitorConfigBuilder(BmpMonitorConfig base)
Construct a builder initialized with state from specifiedBmpMonitorConfig
.- Parameters:
base
- BmpMonitorConfig from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public BmpMonitorConfigKey key()
Return current value associated with the property corresponding toBmpMonitorConfig.key()
.- Returns:
- current value
-
getMonitorId
public MonitorId getMonitorId()
Return current value associated with the property corresponding toBmpMonitorConfig.getMonitorId()
.- Returns:
- current value
-
getMonitoredRouter
public Map<MonitoredRouterKey,MonitoredRouter> getMonitoredRouter()
Return current value associated with the property corresponding toBmpMonitorConfig.getMonitoredRouter()
.- Returns:
- current value
-
getServer
public Server getServer()
Return current value associated with the property corresponding toServerConfig.getServer()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BmpMonitorConfig>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
public BmpMonitorConfigBuilder withKey(BmpMonitorConfigKey key)
-
setMonitorId
public BmpMonitorConfigBuilder setMonitorId(MonitorId value)
Set the property corresponding toBmpMonitorConfig.getMonitorId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMonitoredRouter
public BmpMonitorConfigBuilder setMonitoredRouter(Map<MonitoredRouterKey,MonitoredRouter> values)
Set the property corresponding toBmpMonitorConfig.getMonitoredRouter()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setServer
public BmpMonitorConfigBuilder setServer(Server value)
Set the property corresponding toServerConfig.getServer()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull BmpMonitorConfig build()
A newBmpMonitorConfig
instance.- Returns:
- A new
BmpMonitorConfig
instance.
-
-