Class SourceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.programming.rev130930.create.p2p.tunnel.input.SourceBuilder
-
@Generated("mdsal-binding-generator") public class SourceBuilder extends Object
Class that buildsSource
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:
Source createSource(int fooXyzzy, int barBaz) { return new SourceBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Source, 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:
Source
- 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 SourceBuilder()
Construct an empty builder.SourceBuilder(Source base)
Construct a builder initialized with state from specifiedSource
.SourceBuilder(TpReference arg)
Construct a new builder initialized from specifiedTpReference
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SourceBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Source> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Source>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Source
build()
A newSource
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId
getNode()
Return current value associated with the property corresponding toTpReference.getNode()
.org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId
getTp()
Return current value associated with the property corresponding toTpReference.getTp()
.SourceBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Source>> augmentationType)
Remove an augmentation from this builder's product.SourceBuilder
setNode(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
Set the property corresponding toTpReference.getNode()
to the specified value.SourceBuilder
setTp(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId value)
Set the property corresponding toTpReference.getTp()
to the specified value.
-
-
-
Constructor Detail
-
SourceBuilder
public SourceBuilder()
Construct an empty builder.
-
SourceBuilder
public SourceBuilder(TpReference arg)
Construct a new builder initialized from specifiedTpReference
.- Parameters:
arg
- TpReference from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getNode
public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId getNode()
Return current value associated with the property corresponding toTpReference.getNode()
.- Returns:
- current value
-
getTp
public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId getTp()
Return current value associated with the property corresponding toTpReference.getTp()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Source>> 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
-
setNode
public SourceBuilder setNode(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
Set the property corresponding toTpReference.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTp
public SourceBuilder setTp(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId value)
Set the property corresponding toTpReference.getTp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SourceBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Source> 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 SourceBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Source>> 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
-
-