Class RoutingBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces.state._interface.RoutingBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Routing>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Routing,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class RoutingBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Routing>
Class that buildsRoutingBuilder
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:
RoutingBuilder createTarget(int fooXyzzy, int barBaz) { return new RoutingBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RoutingBuilder, 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:
RoutingBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RoutingBuilder()
RoutingBuilder(Routing base)
RoutingBuilder(RoutingBaseAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RoutingBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routing>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Routing> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.RoutingBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Routing> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Routing>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Routing
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getIpv4VrfId()
org.opendaylight.yangtools.yang.common.Uint32
getIpv6VrfId()
RoutingBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routing>> augmentationType)
Remove an augmentation from this builder's product.RoutingBuilder
setIpv4VrfId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpv4VrfId(Uint32)
instead.RoutingBuilder
setIpv4VrfId(org.opendaylight.yangtools.yang.common.Uint32 value)
RoutingBuilder
setIpv6VrfId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpv6VrfId(Uint32)
instead.RoutingBuilder
setIpv6VrfId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
RoutingBuilder
public RoutingBuilder()
-
RoutingBuilder
public RoutingBuilder(RoutingBaseAttributes arg)
-
RoutingBuilder
public RoutingBuilder(Routing 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.v3po.rev170607.RoutingBaseAttributes
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getIpv4VrfId
public org.opendaylight.yangtools.yang.common.Uint32 getIpv4VrfId()
-
getIpv6VrfId
public org.opendaylight.yangtools.yang.common.Uint32 getIpv6VrfId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Routing>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setIpv4VrfId
public RoutingBuilder setIpv4VrfId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setIpv4VrfId
@Deprecated(forRemoval=true) public RoutingBuilder setIpv4VrfId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpv4VrfId(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setIpv6VrfId
public RoutingBuilder setIpv6VrfId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setIpv6VrfId
@Deprecated(forRemoval=true) public RoutingBuilder setIpv6VrfId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpv6VrfId(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public RoutingBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Routing> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public RoutingBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routing>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Routing> 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 RoutingBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routing>> 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
-
-