Class MonitoredRouterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.config.rev200120.odl.bmp.monitors.bmp.monitor.config.MonitoredRouterBuilder
-
@Generated("mdsal-binding-generator") public class MonitoredRouterBuilder extends Object
Class that buildsMonitoredRouter
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:
MonitoredRouter createMonitoredRouter(int fooXyzzy, int barBaz) { return new MonitoredRouterBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MonitoredRouter, 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:
MonitoredRouter
- 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 MonitoredRouterBuilder()
Construct an empty builder.MonitoredRouterBuilder(MonitoredRouter base)
Construct a builder initialized with state from specifiedMonitoredRouter
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MonitoredRouterBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MonitoredRouter> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoredRouter>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MonitoredRouter
build()
A newMonitoredRouter
instance.Boolean
getActive()
Return current value associated with the property corresponding toMonitoredRouter.getActive()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getAddress()
Return current value associated with the property corresponding toMonitoredRouter.getAddress()
.Rfc2385Key
getPassword()
Return current value associated with the property corresponding toMonitoredRouter.getPassword()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getPort()
Return current value associated with the property corresponding toMonitoredRouter.getPort()
.MonitoredRouterKey
key()
Return current value associated with the property corresponding toMonitoredRouter.key()
.MonitoredRouterBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoredRouter>> augmentationType)
Remove an augmentation from this builder's product.MonitoredRouterBuilder
setActive(Boolean value)
Set the property corresponding toMonitoredRouter.getActive()
to the specified value.MonitoredRouterBuilder
setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toMonitoredRouter.getAddress()
to the specified value.MonitoredRouterBuilder
setPassword(Rfc2385Key value)
Set the property corresponding toMonitoredRouter.getPassword()
to the specified value.MonitoredRouterBuilder
setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
Set the property corresponding toMonitoredRouter.getPort()
to the specified value.MonitoredRouterBuilder
withKey(MonitoredRouterKey key)
-
-
-
Constructor Detail
-
MonitoredRouterBuilder
public MonitoredRouterBuilder()
Construct an empty builder.
-
MonitoredRouterBuilder
public MonitoredRouterBuilder(MonitoredRouter base)
Construct a builder initialized with state from specifiedMonitoredRouter
.- Parameters:
base
- MonitoredRouter from which the builder should be initialized
-
-
Method Detail
-
key
public MonitoredRouterKey key()
Return current value associated with the property corresponding toMonitoredRouter.key()
.- Returns:
- current value
-
getActive
public Boolean getActive()
Return current value associated with the property corresponding toMonitoredRouter.getActive()
.- Returns:
- current value
-
getAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getAddress()
Return current value associated with the property corresponding toMonitoredRouter.getAddress()
.- Returns:
- current value
-
getPassword
public Rfc2385Key getPassword()
Return current value associated with the property corresponding toMonitoredRouter.getPassword()
.- Returns:
- current value
-
getPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPort()
Return current value associated with the property corresponding toMonitoredRouter.getPort()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoredRouter>> 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 MonitoredRouterBuilder withKey(MonitoredRouterKey key)
-
setActive
public MonitoredRouterBuilder setActive(Boolean value)
Set the property corresponding toMonitoredRouter.getActive()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAddress
public MonitoredRouterBuilder setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toMonitoredRouter.getAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPassword
public MonitoredRouterBuilder setPassword(Rfc2385Key value)
Set the property corresponding toMonitoredRouter.getPassword()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPort
public MonitoredRouterBuilder setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
Set the property corresponding toMonitoredRouter.getPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MonitoredRouterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MonitoredRouter> 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 MonitoredRouterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoredRouter>> 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 MonitoredRouter build()
A newMonitoredRouter
instance.- Returns:
- A new
MonitoredRouter
instance.
-
-