Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pmsi.tunnel.rev200120.pmsi.tunnel
Class PmsiTunnelBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pmsi.tunnel.rev200120.pmsi.tunnel.PmsiTunnelBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PmsiTunnel>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PmsiTunnel,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PmsiTunnelBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PmsiTunnel>
Class that buildsPmsiTunnel
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:
PmsiTunnel createPmsiTunnel(int fooXyzzy, int barBaz) { return new PmsiTunnelBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PmsiTunnel, 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:
PmsiTunnel
,Builder
-
-
Constructor Summary
Constructors Constructor Description PmsiTunnelBuilder()
PmsiTunnelBuilder(PmsiTunnel base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PmsiTunnelBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PmsiTunnel> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PmsiTunnel>>
E$$augmentation(Class<E$$> augmentationType)
PmsiTunnel
build()
Boolean
getLeafInformationRequired()
MplsLabel
getMplsLabel()
TunnelIdentifier
getTunnelIdentifier()
PmsiTunnelBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PmsiTunnel>> augmentationType)
Remove an augmentation from this builder's product.PmsiTunnelBuilder
setLeafInformationRequired(Boolean value)
PmsiTunnelBuilder
setMplsLabel(MplsLabel value)
PmsiTunnelBuilder
setTunnelIdentifier(TunnelIdentifier value)
-
-
-
Constructor Detail
-
PmsiTunnelBuilder
public PmsiTunnelBuilder()
-
PmsiTunnelBuilder
public PmsiTunnelBuilder(PmsiTunnel base)
-
-
Method Detail
-
getLeafInformationRequired
public Boolean getLeafInformationRequired()
-
getMplsLabel
public MplsLabel getMplsLabel()
-
getTunnelIdentifier
public TunnelIdentifier getTunnelIdentifier()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PmsiTunnel>> E$$ augmentation(Class<E$$> augmentationType)
-
setLeafInformationRequired
public PmsiTunnelBuilder setLeafInformationRequired(Boolean value)
-
setMplsLabel
public PmsiTunnelBuilder setMplsLabel(MplsLabel value)
-
setTunnelIdentifier
public PmsiTunnelBuilder setTunnelIdentifier(TunnelIdentifier value)
-
addAugmentation
public PmsiTunnelBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PmsiTunnel> 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 PmsiTunnelBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PmsiTunnel>> 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 PmsiTunnel build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PmsiTunnel>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PmsiTunnel,IllegalArgumentException>
-
-