Class Ipv6RouteBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv6.routes.ipv6.routes.Ipv6RouteBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv6Route>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6Route,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Ipv6RouteBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ipv6Route>
Class that buildsIpv6Route
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:
Ipv6Route createIpv6Route(int fooXyzzy, int barBaz) { return new Ipv6RouteBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv6Route, 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:
Ipv6Route
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv6RouteBuilder()
Ipv6RouteBuilder(Ipv6Route base)
Ipv6RouteBuilder(Ipv6Prefix arg)
Ipv6RouteBuilder(PathAttributes arg)
Ipv6RouteBuilder(PathIdGrouping arg)
Ipv6RouteBuilder(Route arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv6RouteBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Route> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Route>>
E$$augmentation(Class<E$$> augmentationType)
Ipv6Route
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Attributes
getAttributes()
PathId
getPathId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix
getPrefix()
String
getRouteKey()
Ipv6RouteKey
key()
Ipv6RouteBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Route>> augmentationType)
Remove an augmentation from this builder's product.Ipv6RouteBuilder
setAttributes(Attributes value)
Ipv6RouteBuilder
setPathId(PathId value)
Ipv6RouteBuilder
setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
Ipv6RouteBuilder
setRouteKey(String value)
Ipv6RouteBuilder
withKey(Ipv6RouteKey key)
-
-
-
Constructor Detail
-
Ipv6RouteBuilder
public Ipv6RouteBuilder()
-
Ipv6RouteBuilder
public Ipv6RouteBuilder(Ipv6Prefix arg)
-
Ipv6RouteBuilder
public Ipv6RouteBuilder(Route arg)
-
Ipv6RouteBuilder
public Ipv6RouteBuilder(PathIdGrouping arg)
-
Ipv6RouteBuilder
public Ipv6RouteBuilder(PathAttributes arg)
-
Ipv6RouteBuilder
public Ipv6RouteBuilder(Ipv6Route 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:- PathAttributes
- PathIdGrouping
- Route
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.Ipv6Prefix
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public Ipv6RouteKey key()
-
getAttributes
public Attributes getAttributes()
-
getPathId
public PathId getPathId()
-
getPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix getPrefix()
-
getRouteKey
public String getRouteKey()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Route>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public Ipv6RouteBuilder withKey(Ipv6RouteKey key)
-
setAttributes
public Ipv6RouteBuilder setAttributes(Attributes value)
-
setPathId
public Ipv6RouteBuilder setPathId(PathId value)
-
setPrefix
public Ipv6RouteBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
-
setRouteKey
public Ipv6RouteBuilder setRouteKey(String value)
-
addAugmentation
public Ipv6RouteBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Route> 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 Ipv6RouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Route>> 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 Ipv6Route build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ipv6Route>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6Route,IllegalArgumentException>
-
-