Class Ipv4RouteBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4RouteBuilder
Class that builds
Ipv4Route
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:
Ipv4Route createIpv4Route(int fooXyzzy, int barBaz) {
return new Ipv4RouteBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Ipv4Route, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Ipv4RouteBuilder
(Ipv4Route base) Construct a builder initialized with state from specifiedIpv4Route
.Construct a new builder initialized from specifiedPathAttributes
.Construct a new builder initialized from specifiedPathIdGrouping
.Ipv4RouteBuilder
(Route arg) Construct a new builder initialized from specifiedRoute
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<Ipv4Route> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<Ipv4Route>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Ipv4Route
build()
A newIpv4Route
instance.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toPathAttributes.getAttributes()
.Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix
Return current value associated with the property corresponding toIpv4Route.getPrefix()
.Return current value associated with the property corresponding toRoute.getRouteKey()
.key()
Return current value associated with the property corresponding toIpv4Route.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Ipv4Route>> augmentationType) Remove an augmentation from this builder's product.setAttributes
(Attributes value) Set the property corresponding toPathAttributes.getAttributes()
to the specified value.Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.setPrefix
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value) Set the property corresponding toIpv4Route.getPrefix()
to the specified value.setRouteKey
(String value) Set the property corresponding toRoute.getRouteKey()
to the specified value.withKey
(Ipv4RouteKey key) Set the key value corresponding toIpv4Route.key()
to the specified value.
-
Constructor Details
-
Ipv4RouteBuilder
public Ipv4RouteBuilder()Construct an empty builder. -
Ipv4RouteBuilder
Construct a new builder initialized from specifiedRoute
.- Parameters:
arg
- Route from which the builder should be initialized
-
Ipv4RouteBuilder
Construct a new builder initialized from specifiedPathIdGrouping
.- Parameters:
arg
- PathIdGrouping from which the builder should be initialized
-
Ipv4RouteBuilder
Construct a new builder initialized from specifiedPathAttributes
.- Parameters:
arg
- PathAttributes from which the builder should be initialized
-
Ipv4RouteBuilder
Construct a builder initialized with state from specifiedIpv4Route
.- Parameters:
base
- Ipv4Route from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
Return current value associated with the property corresponding toIpv4Route.key()
.- Returns:
- current value
-
getAttributes
Return current value associated with the property corresponding toPathAttributes.getAttributes()
.- Returns:
- current value
-
getPathId
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.- Returns:
- current value
-
getPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix getPrefix()Return current value associated with the property corresponding toIpv4Route.getPrefix()
.- Returns:
- current value
-
getRouteKey
Return current value associated with the property corresponding toRoute.getRouteKey()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<Ipv4Route>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
Set the key value corresponding toIpv4Route.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setAttributes
Set the property corresponding toPathAttributes.getAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPathId
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrefix
public Ipv4RouteBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value) Set the property corresponding toIpv4Route.getPrefix()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteKey
Set the property corresponding toRoute.getRouteKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv4RouteBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<Ipv4Route> 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 Ipv4RouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Ipv4Route>> 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
A newIpv4Route
instance.- Returns:
- A new
Ipv4Route
instance.
-