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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ConnectionPoint>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ConnectionPoint,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ConnectionPointBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ConnectionPoint>
Class that buildsConnectionPointBuilder
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:
ConnectionPointBuilder createTarget(int fooXyzzy, int barBaz) { return new ConnectionPointBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ConnectionPointBuilder, 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:
ConnectionPointBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ConnectionPointBuilder()
ConnectionPointBuilder(ConnectionPoint base)
-
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)
ConnectionPoint
build()
Config
getConfig()
String
getConnectionPointId()
Endpoints
getEndpoints()
State
getState()
ConnectionPointKey
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)
ConnectionPointBuilder
setConnectionPointId(String value)
ConnectionPointBuilder
setEndpoints(Endpoints value)
ConnectionPointBuilder
setState(State value)
ConnectionPointBuilder
withKey(ConnectionPointKey key)
-
-
-
Constructor Detail
-
ConnectionPointBuilder
public ConnectionPointBuilder()
-
ConnectionPointBuilder
public ConnectionPointBuilder(ConnectionPoint base)
-
-
Method Detail
-
key
public ConnectionPointKey key()
-
getConfig
public Config getConfig()
-
getConnectionPointId
public String getConnectionPointId()
-
getEndpoints
public Endpoints getEndpoints()
-
getState
public State getState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionPoint>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public ConnectionPointBuilder withKey(ConnectionPointKey key)
-
setConfig
public ConnectionPointBuilder setConfig(Config value)
-
setConnectionPointId
public ConnectionPointBuilder setConnectionPointId(String value)
-
setEndpoints
public ConnectionPointBuilder setEndpoints(Endpoints value)
-
setState
public ConnectionPointBuilder setState(State value)
-
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 ConnectionPoint build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ConnectionPoint>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ConnectionPoint,IllegalArgumentException>
-
-