Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.redistribute.protocol
Class RipBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.redistribute.protocol.RipBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Rip>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Rip,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class RipBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Rip>
Class that buildsRipBuilder
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:
RipBuilder createTarget(int fooXyzzy, int barBaz) { return new RipBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RipBuilder, 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:
RipBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RipBuilder()
RipBuilder(Rip base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RipBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Rip> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Rip>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Rip
build()
java.lang.Boolean
getEnableRip()
java.lang.Boolean
isEnableRip()
Deprecated, for removal: This API element is subject to removal in a future version.RipBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Rip>> augmentationType)
Remove an augmentation from this builder's product.RipBuilder
setEnableRip(java.lang.Boolean value)
-
-
-
Constructor Detail
-
RipBuilder
public RipBuilder()
-
RipBuilder
public RipBuilder(Rip base)
-
-
Method Detail
-
getEnableRip
public java.lang.Boolean getEnableRip()
-
isEnableRip
@Deprecated(forRemoval=true) public final java.lang.Boolean isEnableRip()
Deprecated, for removal: This API element is subject to removal in a future version.
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Rip>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setEnableRip
public RipBuilder setEnableRip(java.lang.Boolean value)
-
addAugmentation
public RipBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Rip> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public RipBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Rip>> 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
-
-