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