Class ApplicationRibBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.ApplicationRibBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ApplicationRib>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ApplicationRib,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ApplicationRibBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ApplicationRib>
Class that buildsApplicationRib
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:
ApplicationRib createApplicationRib(int fooXyzzy, int barBaz) { return new ApplicationRibBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ApplicationRib, 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:
ApplicationRib
,Builder
-
-
Constructor Summary
Constructors Constructor Description ApplicationRibBuilder()
ApplicationRibBuilder(ApplicationRib base)
ApplicationRibBuilder(Rib arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApplicationRibBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ApplicationRib> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ApplicationRib>>
E$$augmentation(Class<E$$> augmentationType)
ApplicationRib
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ApplicationRibId
getId()
Map<TablesKey,Tables>
getTables()
ApplicationRibKey
key()
ApplicationRibBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ApplicationRib>> augmentationType)
Remove an augmentation from this builder's product.ApplicationRibBuilder
setId(ApplicationRibId value)
ApplicationRibBuilder
setTables(Map<TablesKey,Tables> values)
ApplicationRibBuilder
withKey(ApplicationRibKey key)
-
-
-
Constructor Detail
-
ApplicationRibBuilder
public ApplicationRibBuilder()
-
ApplicationRibBuilder
public ApplicationRibBuilder(Rib arg)
-
ApplicationRibBuilder
public ApplicationRibBuilder(ApplicationRib 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:- Rib
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public ApplicationRibKey key()
-
getId
public ApplicationRibId getId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ApplicationRib>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public ApplicationRibBuilder withKey(ApplicationRibKey key)
-
setId
public ApplicationRibBuilder setId(ApplicationRibId value)
-
setTables
public ApplicationRibBuilder setTables(Map<TablesKey,Tables> values)
-
addAugmentation
public ApplicationRibBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ApplicationRib> 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 ApplicationRibBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ApplicationRib>> 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 ApplicationRib build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ApplicationRib>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ApplicationRib,IllegalArgumentException>
-
-