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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Endpoint>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Endpoint,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class EndpointBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Endpoint>
Class that buildsEndpointBuilder
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:
EndpointBuilder createTarget(int fooXyzzy, int barBaz) { return new EndpointBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EndpointBuilder, 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:
EndpointBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description EndpointBuilder()
EndpointBuilder(Endpoint base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EndpointBuilder
addAugmentation(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)
Endpoint
build()
Config
getConfig()
String
getEndpointId()
State
getState()
EndpointKey
key()
EndpointBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Endpoint>> augmentationType)
Remove an augmentation from this builder's product.EndpointBuilder
setConfig(Config value)
EndpointBuilder
setEndpointId(String value)
EndpointBuilder
setState(State value)
EndpointBuilder
withKey(EndpointKey key)
-
-
-
Constructor Detail
-
EndpointBuilder
public EndpointBuilder()
-
EndpointBuilder
public EndpointBuilder(Endpoint base)
-
-
Method Detail
-
key
public EndpointKey key()
-
getConfig
public Config getConfig()
-
getEndpointId
public String getEndpointId()
-
getState
public State getState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Endpoint>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public EndpointBuilder withKey(EndpointKey key)
-
setConfig
public EndpointBuilder setConfig(Config value)
-
setEndpointId
public EndpointBuilder setEndpointId(String value)
-
setState
public EndpointBuilder setState(State value)
-
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
public Endpoint build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Endpoint>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Endpoint,IllegalArgumentException>
-
-