Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.ipv4.unicast.group
Class Ipv4UnicastBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.ipv4.unicast.group.Ipv4UnicastBuilder
-
@Generated("mdsal-binding-generator") public class Ipv4UnicastBuilder extends Object
Class that buildsIpv4Unicast
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:
Ipv4Unicast createIpv4Unicast(int fooXyzzy, int barBaz) { return new Ipv4UnicastBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv4Unicast, 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:
Ipv4Unicast
- 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
-
-
Constructor Summary
Constructors Constructor Description Ipv4UnicastBuilder()
Construct an empty builder.Ipv4UnicastBuilder(AllAfiSafiCommon arg)
Construct a new builder initialized from specifiedAllAfiSafiCommon
.Ipv4UnicastBuilder(Ipv4Unicast base)
Construct a builder initialized with state from specifiedIpv4Unicast
.Ipv4UnicastBuilder(Ipv4Ipv6UnicastCommon arg)
Construct a new builder initialized from specifiedIpv4Ipv6UnicastCommon
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv4UnicastBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Unicast> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Unicast>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Ipv4Unicast
build()
A newIpv4Unicast
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Config
getConfig()
Return current value associated with the property corresponding toIpv4Ipv6UnicastCommon.getConfig()
.PrefixLimit
getPrefixLimit()
Return current value associated with the property corresponding toAllAfiSafiCommon.getPrefixLimit()
.State
getState()
Return current value associated with the property corresponding toIpv4Ipv6UnicastCommon.getState()
.Ipv4UnicastBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Unicast>> augmentationType)
Remove an augmentation from this builder's product.Ipv4UnicastBuilder
setConfig(Config value)
Set the property corresponding toIpv4Ipv6UnicastCommon.getConfig()
to the specified value.Ipv4UnicastBuilder
setPrefixLimit(PrefixLimit value)
Set the property corresponding toAllAfiSafiCommon.getPrefixLimit()
to the specified value.Ipv4UnicastBuilder
setState(State value)
Set the property corresponding toIpv4Ipv6UnicastCommon.getState()
to the specified value.
-
-
-
Constructor Detail
-
Ipv4UnicastBuilder
public Ipv4UnicastBuilder()
Construct an empty builder.
-
Ipv4UnicastBuilder
public Ipv4UnicastBuilder(Ipv4Ipv6UnicastCommon arg)
Construct a new builder initialized from specifiedIpv4Ipv6UnicastCommon
.- Parameters:
arg
- Ipv4Ipv6UnicastCommon from which the builder should be initialized
-
Ipv4UnicastBuilder
public Ipv4UnicastBuilder(AllAfiSafiCommon arg)
Construct a new builder initialized from specifiedAllAfiSafiCommon
.- Parameters:
arg
- AllAfiSafiCommon from which the builder should be initialized
-
Ipv4UnicastBuilder
public Ipv4UnicastBuilder(Ipv4Unicast base)
Construct a builder initialized with state from specifiedIpv4Unicast
.- Parameters:
base
- Ipv4Unicast from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getConfig
public Config getConfig()
Return current value associated with the property corresponding toIpv4Ipv6UnicastCommon.getConfig()
.- Returns:
- current value
-
getPrefixLimit
public PrefixLimit getPrefixLimit()
Return current value associated with the property corresponding toAllAfiSafiCommon.getPrefixLimit()
.- Returns:
- current value
-
getState
public State getState()
Return current value associated with the property corresponding toIpv4Ipv6UnicastCommon.getState()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Unicast>> 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
-
setConfig
public Ipv4UnicastBuilder setConfig(Config value)
Set the property corresponding toIpv4Ipv6UnicastCommon.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrefixLimit
public Ipv4UnicastBuilder setPrefixLimit(PrefixLimit value)
Set the property corresponding toAllAfiSafiCommon.getPrefixLimit()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
public Ipv4UnicastBuilder setState(State value)
Set the property corresponding toIpv4Ipv6UnicastCommon.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv4UnicastBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Unicast> 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 Ipv4UnicastBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Unicast>> 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 @NonNull Ipv4Unicast build()
A newIpv4Unicast
instance.- Returns:
- A new
Ipv4Unicast
instance.
-
-