Class GracefulRestartCapabilityBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.GracefulRestartCapabilityBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<GracefulRestartCapability>
,org.opendaylight.yangtools.concepts.CheckedBuilder<GracefulRestartCapability,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class GracefulRestartCapabilityBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<GracefulRestartCapability>
Class that buildsGracefulRestartCapabilityBuilder
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:
GracefulRestartCapabilityBuilder createTarget(int fooXyzzy, int barBaz) { return new GracefulRestartCapabilityBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GracefulRestartCapabilityBuilder, 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:
GracefulRestartCapabilityBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description GracefulRestartCapabilityBuilder()
GracefulRestartCapabilityBuilder(GracefulRestartCapability base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GracefulRestartCapabilityBuilder
addAugmentation(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)
GracefulRestartCapability
build()
GracefulRestartCapability.RestartFlags
getRestartFlags()
org.opendaylight.yangtools.yang.common.Uint16
getRestartTime()
Map<TablesKey,Tables>
getTables()
GracefulRestartCapabilityBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GracefulRestartCapability>> augmentationType)
Remove an augmentation from this builder's product.GracefulRestartCapabilityBuilder
setRestartFlags(GracefulRestartCapability.RestartFlags value)
GracefulRestartCapabilityBuilder
setRestartTime(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRestartTime(Uint16)
instead.GracefulRestartCapabilityBuilder
setRestartTime(org.opendaylight.yangtools.yang.common.Uint16 value)
GracefulRestartCapabilityBuilder
setTables(List<Tables> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTables(Map)
instead.GracefulRestartCapabilityBuilder
setTables(Map<TablesKey,Tables> values)
-
-
-
Constructor Detail
-
GracefulRestartCapabilityBuilder
public GracefulRestartCapabilityBuilder()
-
GracefulRestartCapabilityBuilder
public GracefulRestartCapabilityBuilder(GracefulRestartCapability base)
-
-
Method Detail
-
getRestartFlags
public GracefulRestartCapability.RestartFlags getRestartFlags()
-
getRestartTime
public org.opendaylight.yangtools.yang.common.Uint16 getRestartTime()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GracefulRestartCapability>> E$$ augmentation(Class<E$$> augmentationType)
-
setRestartFlags
public GracefulRestartCapabilityBuilder setRestartFlags(GracefulRestartCapability.RestartFlags value)
-
setRestartTime
public GracefulRestartCapabilityBuilder setRestartTime(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setRestartTime
@Deprecated(forRemoval=true) public GracefulRestartCapabilityBuilder setRestartTime(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRestartTime(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTables
public GracefulRestartCapabilityBuilder setTables(Map<TablesKey,Tables> values)
-
setTables
@Deprecated(forRemoval=true) public GracefulRestartCapabilityBuilder setTables(List<Tables> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTables(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
-
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
public GracefulRestartCapability build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<GracefulRestartCapability>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<GracefulRestartCapability,IllegalArgumentException>
-
-