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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MonitoredRouter>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MonitoredRouter,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MonitoredRouterBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MonitoredRouter>
Class that buildsMonitoredRouterBuilder
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:
MonitoredRouterBuilder createTarget(int fooXyzzy, int barBaz) { return new MonitoredRouterBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MonitoredRouterBuilder, 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:
MonitoredRouterBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MonitoredRouterBuilder()
MonitoredRouterBuilder(MonitoredRouter base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
MonitoredRouter
build()
Boolean
getActive()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getAddress()
Rfc2385Key
getPassword()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getPort()
Boolean
isActive()
Deprecated, for removal: This API element is subject to removal in a future version.MonitoredRouterKey
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)
MonitoredRouterBuilder
setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
MonitoredRouterBuilder
setPassword(Rfc2385Key value)
MonitoredRouterBuilder
setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
MonitoredRouterBuilder
withKey(MonitoredRouterKey key)
-
-
-
Constructor Detail
-
MonitoredRouterBuilder
public MonitoredRouterBuilder()
-
MonitoredRouterBuilder
public MonitoredRouterBuilder(MonitoredRouter base)
-
-
Method Detail
-
key
public MonitoredRouterKey key()
-
getActive
public Boolean getActive()
-
isActive
@Deprecated(forRemoval=true) public final Boolean isActive()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getAddress()
-
getPassword
public Rfc2385Key getPassword()
-
getPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPort()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoredRouter>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public MonitoredRouterBuilder withKey(MonitoredRouterKey key)
-
setActive
public MonitoredRouterBuilder setActive(Boolean value)
-
setAddress
public MonitoredRouterBuilder setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
-
setPassword
public MonitoredRouterBuilder setPassword(Rfc2385Key value)
-
setPort
public MonitoredRouterBuilder setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
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 MonitoredRouter build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MonitoredRouter>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MonitoredRouter,IllegalArgumentException>
-
-