Class DestinationFlowspecL3vpnIpv4Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.l3vpn.destination.ipv4.DestinationFlowspecL3vpnIpv4Builder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<DestinationFlowspecL3vpnIpv4>
,org.opendaylight.yangtools.concepts.CheckedBuilder<DestinationFlowspecL3vpnIpv4,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class DestinationFlowspecL3vpnIpv4Builder extends Object implements org.opendaylight.yangtools.concepts.Builder<DestinationFlowspecL3vpnIpv4>
Class that buildsDestinationFlowspecL3vpnIpv4Builder
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:
DestinationFlowspecL3vpnIpv4Builder createTarget(int fooXyzzy, int barBaz) { return new DestinationFlowspecL3vpnIpv4BuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DestinationFlowspecL3vpnIpv4Builder, 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:
DestinationFlowspecL3vpnIpv4Builder
,Builder
-
-
Constructor Summary
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DestinationFlowspecL3vpnIpv4Builder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv4>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv4> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.DestinationFlowspecL3vpnIpv4Builder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv4> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv4>>
E$$augmentation(Class<E$$> augmentationType)
DestinationFlowspecL3vpnIpv4
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Flowspec>
getFlowspec()
PathId
getPathId()
RouteDistinguisher
getRouteDistinguisher()
DestinationFlowspecL3vpnIpv4Builder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv4>> augmentationType)
Remove an augmentation from this builder's product.DestinationFlowspecL3vpnIpv4Builder
setFlowspec(List<Flowspec> values)
DestinationFlowspecL3vpnIpv4Builder
setPathId(PathId value)
DestinationFlowspecL3vpnIpv4Builder
setRouteDistinguisher(RouteDistinguisher value)
-
-
-
Constructor Detail
-
DestinationFlowspecL3vpnIpv4Builder
public DestinationFlowspecL3vpnIpv4Builder()
-
DestinationFlowspecL3vpnIpv4Builder
public DestinationFlowspecL3vpnIpv4Builder(RouteDistinguisherGrouping arg)
-
DestinationFlowspecL3vpnIpv4Builder
public DestinationFlowspecL3vpnIpv4Builder(FlowspecDestinationGroupIpv4 arg)
-
DestinationFlowspecL3vpnIpv4Builder
public DestinationFlowspecL3vpnIpv4Builder(FlowspecDestination arg)
-
DestinationFlowspecL3vpnIpv4Builder
public DestinationFlowspecL3vpnIpv4Builder(PathIdGrouping arg)
-
DestinationFlowspecL3vpnIpv4Builder
public DestinationFlowspecL3vpnIpv4Builder(DestinationFlowspecL3vpnIpv4 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.bgp.message.rev200120.PathIdGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.FlowspecDestination
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.RouteDistinguisherGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.FlowspecDestinationGroupIpv4
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getPathId
public PathId getPathId()
-
getRouteDistinguisher
public RouteDistinguisher getRouteDistinguisher()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv4>> E$$ augmentation(Class<E$$> augmentationType)
-
setFlowspec
public DestinationFlowspecL3vpnIpv4Builder setFlowspec(List<Flowspec> values)
-
setPathId
public DestinationFlowspecL3vpnIpv4Builder setPathId(PathId value)
-
setRouteDistinguisher
public DestinationFlowspecL3vpnIpv4Builder setRouteDistinguisher(RouteDistinguisher value)
-
addAugmentation
public DestinationFlowspecL3vpnIpv4Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv4> 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 DestinationFlowspecL3vpnIpv4Builder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv4>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv4> 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 DestinationFlowspecL3vpnIpv4Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv4>> 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 DestinationFlowspecL3vpnIpv4 build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<DestinationFlowspecL3vpnIpv4>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<DestinationFlowspecL3vpnIpv4,IllegalArgumentException>
-
-