Class TunnelBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.TunnelBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Tunnel>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Tunnel,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class TunnelBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Tunnel>
Class that buildsTunnelBuilder
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:
TunnelBuilder createTarget(int fooXyzzy, int barBaz) { return new TunnelBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TunnelBuilder, 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:
TunnelBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TunnelBuilder()
TunnelBuilder(Tunnel base)
TunnelBuilder(TunnelTypeAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Tunnel
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Class<? extends TunnelTypeBase>
getTunnelType()
TunnelBuilder
setTunnelType(Class<? extends TunnelTypeBase> value)
-
-
-
Constructor Detail
-
TunnelBuilder
public TunnelBuilder()
-
TunnelBuilder
public TunnelBuilder(TunnelTypeAttributes arg)
-
TunnelBuilder
public TunnelBuilder(Tunnel 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.overlay.rev150105.TunnelTypeAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getTunnelType
public Class<? extends TunnelTypeBase> getTunnelType()
-
setTunnelType
public TunnelBuilder setTunnelType(Class<? extends TunnelTypeBase> value)
-
build
public Tunnel build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Tunnel>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Tunnel,IllegalArgumentException>
-
-