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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Source>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Source,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class SourceBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Source>
Class that buildsSourceBuilder
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:
SourceBuilder createTarget(int fooXyzzy, int barBaz) { return new SourceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SourceBuilder, 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:
SourceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SourceBuilder()
SourceBuilder(Source base)
SourceBuilder(TpReference arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SourceBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Source>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Source> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.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)
Source
build()
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()
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId
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)
SourceBuilder
setTp(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId value)
-
-
-
Constructor Detail
-
SourceBuilder
public SourceBuilder()
-
SourceBuilder
public SourceBuilder(TpReference arg)
-
SourceBuilder
public SourceBuilder(Source base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.programming.rev130930.TpReference
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getNode
public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId getNode()
-
getTp
public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId getTp()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Source>> E$$ augmentation(Class<E$$> augmentationType)
-
setNode
public SourceBuilder setNode(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
-
setTp
public SourceBuilder setTp(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId value)
-
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
-
addAugmentation
@Deprecated(forRemoval=true) public SourceBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Source>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Source> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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
-
build
public Source build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Source>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Source,IllegalArgumentException>
-
-