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