Class GracefulRestartCapabilityBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.GracefulRestartCapabilityBuilder
Class that builds
GracefulRestartCapability
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:
GracefulRestartCapability createGracefulRestartCapability(int fooXyzzy, int barBaz) {
return new GracefulRestartCapabilityBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of GracefulRestartCapability, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedGracefulRestartCapability
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<GracefulRestartCapability> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GracefulRestartCapability>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull GracefulRestartCapability
build()
A newGracefulRestartCapability
instance.Return current value associated with the property corresponding toGracefulRestartCapability.getRestartFlags()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toGracefulRestartCapability.getRestartTime()
.Return current value associated with the property corresponding toGracefulRestartCapability.getTables()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GracefulRestartCapability>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toGracefulRestartCapability.getRestartFlags()
to the specified value.setRestartTime
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toGracefulRestartCapability.getRestartTime()
to the specified value.Set the property corresponding toGracefulRestartCapability.getTables()
to the specified value.
-
Constructor Details
-
GracefulRestartCapabilityBuilder
public GracefulRestartCapabilityBuilder()Construct an empty builder. -
GracefulRestartCapabilityBuilder
Construct a builder initialized with state from specifiedGracefulRestartCapability
.- Parameters:
base
- GracefulRestartCapability from which the builder should be initialized
-
-
Method Details
-
getRestartFlags
Return current value associated with the property corresponding toGracefulRestartCapability.getRestartFlags()
.- Returns:
- current value
-
getRestartTime
public org.opendaylight.yangtools.yang.common.Uint16 getRestartTime()Return current value associated with the property corresponding toGracefulRestartCapability.getRestartTime()
.- Returns:
- current value
-
getTables
Return current value associated with the property corresponding toGracefulRestartCapability.getTables()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GracefulRestartCapability>> 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
-
setRestartFlags
public GracefulRestartCapabilityBuilder setRestartFlags(GracefulRestartCapability.RestartFlags value) Set the property corresponding toGracefulRestartCapability.getRestartFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRestartTime
public GracefulRestartCapabilityBuilder setRestartTime(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toGracefulRestartCapability.getRestartTime()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTables
Set the property corresponding toGracefulRestartCapability.getTables()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public GracefulRestartCapabilityBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GracefulRestartCapability> 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 GracefulRestartCapabilityBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GracefulRestartCapability>> 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
A newGracefulRestartCapability
instance.- Returns:
- A new
GracefulRestartCapability
instance.
-