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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv4Unicast>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4Unicast,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Ipv4UnicastBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ipv4Unicast>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv4UnicastBuilder()
Ipv4UnicastBuilder(AllAfiSafiCommon arg)
Ipv4UnicastBuilder(Ipv4Unicast base)
Ipv4UnicastBuilder(Ipv4Ipv6UnicastCommon arg)
-
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)
Ipv4Unicast
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Config
getConfig()
PrefixLimit
getPrefixLimit()
State
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)
Ipv4UnicastBuilder
setPrefixLimit(PrefixLimit value)
Ipv4UnicastBuilder
setState(State value)
-
-
-
Constructor Detail
-
Ipv4UnicastBuilder
public Ipv4UnicastBuilder()
-
Ipv4UnicastBuilder
public Ipv4UnicastBuilder(Ipv4Ipv6UnicastCommon arg)
-
Ipv4UnicastBuilder
public Ipv4UnicastBuilder(AllAfiSafiCommon arg)
-
Ipv4UnicastBuilder
public Ipv4UnicastBuilder(Ipv4Unicast 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:- AllAfiSafiCommon
- Ipv4Ipv6UnicastCommon
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getConfig
public Config getConfig()
-
getPrefixLimit
public PrefixLimit getPrefixLimit()
-
getState
public State getState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Unicast>> E$$ augmentation(Class<E$$> augmentationType)
-
setConfig
public Ipv4UnicastBuilder setConfig(Config value)
-
setPrefixLimit
public Ipv4UnicastBuilder setPrefixLimit(PrefixLimit value)
-
setState
public Ipv4UnicastBuilder setState(State value)
-
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 Ipv4Unicast build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ipv4Unicast>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4Unicast,IllegalArgumentException>
-
-