Class ConnectionPointsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.ConnectionPointsBuilder
-
@Generated("mdsal-binding-generator") public class ConnectionPointsBuilder extends Object
Class that buildsConnectionPoints
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:
ConnectionPoints createConnectionPoints(int fooXyzzy, int barBaz) { return new ConnectionPointsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ConnectionPoints, 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:
ConnectionPoints
- 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 ConnectionPointsBuilder()
Construct an empty builder.ConnectionPointsBuilder(ConnectionPoints base)
Construct a builder initialized with state from specifiedConnectionPoints
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ConnectionPointsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionPoints> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionPoints>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ConnectionPoints
build()
A newConnectionPoints
instance.Map<ConnectionPointKey,ConnectionPoint>
getConnectionPoint()
Return current value associated with the property corresponding toConnectionPoints.getConnectionPoint()
.ConnectionPointsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionPoints>> augmentationType)
Remove an augmentation from this builder's product.ConnectionPointsBuilder
setConnectionPoint(Map<ConnectionPointKey,ConnectionPoint> values)
Set the property corresponding toConnectionPoints.getConnectionPoint()
to the specified value.
-
-
-
Constructor Detail
-
ConnectionPointsBuilder
public ConnectionPointsBuilder()
Construct an empty builder.
-
ConnectionPointsBuilder
public ConnectionPointsBuilder(ConnectionPoints base)
Construct a builder initialized with state from specifiedConnectionPoints
.- Parameters:
base
- ConnectionPoints from which the builder should be initialized
-
-
Method Detail
-
getConnectionPoint
public Map<ConnectionPointKey,ConnectionPoint> getConnectionPoint()
Return current value associated with the property corresponding toConnectionPoints.getConnectionPoint()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionPoints>> 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
-
setConnectionPoint
public ConnectionPointsBuilder setConnectionPoint(Map<ConnectionPointKey,ConnectionPoint> values)
Set the property corresponding toConnectionPoints.getConnectionPoint()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public ConnectionPointsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionPoints> 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 ConnectionPointsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionPoints>> 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 ConnectionPoints build()
A newConnectionPoints
instance.- Returns:
- A new
ConnectionPoints
instance.
-
-