Class EndpointBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.connection.points.connection.point.endpoints.EndpointBuilder
Class that builds
Endpoint
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:
Endpoint createEndpoint(int fooXyzzy, int barBaz) {
return new EndpointBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Endpoint, 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.EndpointBuilder
(Endpoint base) Construct a builder initialized with state from specifiedEndpoint
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Endpoint> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Endpoint>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Endpoint
build()
A newEndpoint
instance.Return current value associated with the property corresponding toEndpoint.getConfig()
.Return current value associated with the property corresponding toEndpoint.getEndpointId()
.getState()
Return current value associated with the property corresponding toEndpoint.getState()
.key()
Return current value associated with the property corresponding toEndpoint.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Endpoint>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toEndpoint.getConfig()
to the specified value.setEndpointId
(String value) Set the property corresponding toEndpoint.getEndpointId()
to the specified value.Set the property corresponding toEndpoint.getState()
to the specified value.withKey
(EndpointKey key) Set the key value corresponding toEndpoint.key()
to the specified value.
-
Constructor Details
-
EndpointBuilder
public EndpointBuilder()Construct an empty builder. -
EndpointBuilder
Construct a builder initialized with state from specifiedEndpoint
.- Parameters:
base
- Endpoint from which the builder should be initialized
-
-
Method Details
-
key
Return current value associated with the property corresponding toEndpoint.key()
.- Returns:
- current value
-
getConfig
Return current value associated with the property corresponding toEndpoint.getConfig()
.- Returns:
- current value
-
getEndpointId
Return current value associated with the property corresponding toEndpoint.getEndpointId()
.- Returns:
- current value
-
getState
Return current value associated with the property corresponding toEndpoint.getState()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Endpoint>> 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
Set the key value corresponding toEndpoint.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setConfig
Set the property corresponding toEndpoint.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEndpointId
Set the property corresponding toEndpoint.getEndpointId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
Set the property corresponding toEndpoint.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public EndpointBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Endpoint> 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 EndpointBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Endpoint>> 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 newEndpoint
instance.- Returns:
- A new
Endpoint
instance.
-