Class DestinationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.programming.rev130930.create.p2p.tunnel.input.DestinationBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Destination>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Destination,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class DestinationBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Destination>
Class that buildsDestinationBuilder
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:
DestinationBuilder createTarget(int fooXyzzy, int barBaz) { return new DestinationBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DestinationBuilder, 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:
DestinationBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description DestinationBuilder()
DestinationBuilder(Destination base)
DestinationBuilder(TpReference arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DestinationBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Destination>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Destination> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Destination>>
E$$augmentation(Class<E$$> augmentationType)
Destination
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()
DestinationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Destination>> augmentationType)
DestinationBuilder
setNode(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
DestinationBuilder
setTp(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId value)
-
-
-
Constructor Detail
-
DestinationBuilder
public DestinationBuilder()
-
DestinationBuilder
public DestinationBuilder(TpReference arg)
-
DestinationBuilder
public DestinationBuilder(Destination 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<Destination>> E$$ augmentation(Class<E$$> augmentationType)
-
setNode
public DestinationBuilder setNode(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
-
setTp
public DestinationBuilder setTp(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId value)
-
addAugmentation
public DestinationBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Destination>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Destination> augmentationValue)
-
removeAugmentation
public DestinationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Destination>> augmentationType)
-
build
public Destination build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Destination>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Destination,IllegalArgumentException>
-
-