Class ConnectionPointBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.connection.points.ConnectionPointBuilder
-
@Generated("mdsal-binding-generator") public class ConnectionPointBuilder extends Object
Class that buildsConnectionPoint
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:
ConnectionPoint createConnectionPoint(int fooXyzzy, int barBaz) { return new ConnectionPointBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ConnectionPoint, 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:
ConnectionPoint
- 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 ConnectionPointBuilder()
Construct an empty builder.ConnectionPointBuilder(ConnectionPoint base)
Construct a builder initialized with state from specifiedConnectionPoint
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ConnectionPointBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionPoint> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionPoint>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ConnectionPoint
build()
A newConnectionPoint
instance.Config
getConfig()
Return current value associated with the property corresponding toConnectionPoint.getConfig()
.String
getConnectionPointId()
Return current value associated with the property corresponding toConnectionPoint.getConnectionPointId()
.Endpoints
getEndpoints()
Return current value associated with the property corresponding toConnectionPoint.getEndpoints()
.State
getState()
Return current value associated with the property corresponding toConnectionPoint.getState()
.ConnectionPointKey
key()
Return current value associated with the property corresponding toConnectionPoint.key()
.ConnectionPointBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionPoint>> augmentationType)
Remove an augmentation from this builder's product.ConnectionPointBuilder
setConfig(Config value)
Set the property corresponding toConnectionPoint.getConfig()
to the specified value.ConnectionPointBuilder
setConnectionPointId(String value)
Set the property corresponding toConnectionPoint.getConnectionPointId()
to the specified value.ConnectionPointBuilder
setEndpoints(Endpoints value)
Set the property corresponding toConnectionPoint.getEndpoints()
to the specified value.ConnectionPointBuilder
setState(State value)
Set the property corresponding toConnectionPoint.getState()
to the specified value.ConnectionPointBuilder
withKey(ConnectionPointKey key)
-
-
-
Constructor Detail
-
ConnectionPointBuilder
public ConnectionPointBuilder()
Construct an empty builder.
-
ConnectionPointBuilder
public ConnectionPointBuilder(ConnectionPoint base)
Construct a builder initialized with state from specifiedConnectionPoint
.- Parameters:
base
- ConnectionPoint from which the builder should be initialized
-
-
Method Detail
-
key
public ConnectionPointKey key()
Return current value associated with the property corresponding toConnectionPoint.key()
.- Returns:
- current value
-
getConfig
public Config getConfig()
Return current value associated with the property corresponding toConnectionPoint.getConfig()
.- Returns:
- current value
-
getConnectionPointId
public String getConnectionPointId()
Return current value associated with the property corresponding toConnectionPoint.getConnectionPointId()
.- Returns:
- current value
-
getEndpoints
public Endpoints getEndpoints()
Return current value associated with the property corresponding toConnectionPoint.getEndpoints()
.- Returns:
- current value
-
getState
public State getState()
Return current value associated with the property corresponding toConnectionPoint.getState()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionPoint>> 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 ConnectionPointBuilder withKey(ConnectionPointKey key)
-
setConfig
public ConnectionPointBuilder setConfig(Config value)
Set the property corresponding toConnectionPoint.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConnectionPointId
public ConnectionPointBuilder setConnectionPointId(String value)
Set the property corresponding toConnectionPoint.getConnectionPointId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEndpoints
public ConnectionPointBuilder setEndpoints(Endpoints value)
Set the property corresponding toConnectionPoint.getEndpoints()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
public ConnectionPointBuilder setState(State value)
Set the property corresponding toConnectionPoint.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ConnectionPointBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionPoint> 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 ConnectionPointBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionPoint>> 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 ConnectionPoint build()
A newConnectionPoint
instance.- Returns:
- A new
ConnectionPoint
instance.
-
-