Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.redistribute.protocol
Class MobileBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.redistribute.protocol.MobileBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Mobile>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Mobile,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MobileBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Mobile>
Class that buildsMobileBuilder
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:
MobileBuilder createTarget(int fooXyzzy, int barBaz) { return new MobileBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MobileBuilder, 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:
MobileBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MobileBuilder()
MobileBuilder(Mobile base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MobileBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Mobile>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Mobile> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.MobileBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Mobile> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Mobile>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Mobile
build()
java.lang.Boolean
isEnableMobile()
MobileBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Mobile>> augmentationType)
Remove an augmentation from this builder's product.MobileBuilder
setEnableMobile(java.lang.Boolean value)
-
-
-
Constructor Detail
-
MobileBuilder
public MobileBuilder()
-
MobileBuilder
public MobileBuilder(Mobile base)
-
-
Method Detail
-
isEnableMobile
public java.lang.Boolean isEnableMobile()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Mobile>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setEnableMobile
public MobileBuilder setEnableMobile(java.lang.Boolean value)
-
addAugmentation
public MobileBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Mobile> 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
-
addAugmentation
@Deprecated(forRemoval=true) public MobileBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Mobile>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Mobile> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public MobileBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Mobile>> 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
-
-