Class VpnDestinationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.vpn.rev180329.l3vpn.ip.destination.type.VpnDestinationBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnDestination>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnDestination,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VpnDestinationBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<VpnDestination>
Class that buildsVpnDestination
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:
VpnDestination createVpnDestination(int fooXyzzy, int barBaz) { return new VpnDestinationBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnDestination, 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:
VpnDestination
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnDestinationBuilder()
VpnDestinationBuilder(LabeledUnicast arg)
VpnDestinationBuilder(PathIdGrouping arg)
VpnDestinationBuilder(RouteDistinguisherGrouping arg)
VpnDestinationBuilder(L3vpn arg)
VpnDestinationBuilder(VpnDestination base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VpnDestinationBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnDestination> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnDestination>>
E$$augmentation(Class<E$$> augmentationType)
VpnDestination
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<LabelStack>
getLabelStack()
PathId
getPathId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getPrefix()
RouteDistinguisher
getRouteDistinguisher()
VpnDestinationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnDestination>> augmentationType)
Remove an augmentation from this builder's product.VpnDestinationBuilder
setLabelStack(List<LabelStack> values)
VpnDestinationBuilder
setPathId(PathId value)
VpnDestinationBuilder
setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
VpnDestinationBuilder
setRouteDistinguisher(RouteDistinguisher value)
-
-
-
Constructor Detail
-
VpnDestinationBuilder
public VpnDestinationBuilder()
-
VpnDestinationBuilder
public VpnDestinationBuilder(L3vpn arg)
-
VpnDestinationBuilder
public VpnDestinationBuilder(LabeledUnicast arg)
-
VpnDestinationBuilder
public VpnDestinationBuilder(RouteDistinguisherGrouping arg)
-
VpnDestinationBuilder
public VpnDestinationBuilder(PathIdGrouping arg)
-
VpnDestinationBuilder
public VpnDestinationBuilder(VpnDestination 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:- L3vpn
- PathIdGrouping
- LabeledUnicast
- RouteDistinguisherGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getLabelStack
public List<LabelStack> getLabelStack()
-
getPathId
public PathId getPathId()
-
getPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
-
getRouteDistinguisher
public RouteDistinguisher getRouteDistinguisher()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnDestination>> E$$ augmentation(Class<E$$> augmentationType)
-
setLabelStack
public VpnDestinationBuilder setLabelStack(List<LabelStack> values)
-
setPathId
public VpnDestinationBuilder setPathId(PathId value)
-
setPrefix
public VpnDestinationBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
setRouteDistinguisher
public VpnDestinationBuilder setRouteDistinguisher(RouteDistinguisher value)
-
addAugmentation
public VpnDestinationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnDestination> 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 VpnDestinationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnDestination>> 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 VpnDestination build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VpnDestination>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VpnDestination,IllegalArgumentException>
-
-