Class UnicastBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.vpnv4.UnicastBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Unicast>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Unicast,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class UnicastBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Unicast>
Class that buildsUnicastBuilder
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:
UnicastBuilder createTarget(int fooXyzzy, int barBaz) { return new UnicastBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UnicastBuilder, 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:
UnicastBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description UnicastBuilder()
UnicastBuilder(Unicast base)
UnicastBuilder(MaximumPaths arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description UnicastBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Unicast>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Unicast> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Unicast>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Unicast
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Bgp
getBgp()
org.opendaylight.yangtools.yang.common.Uint8
getIbgpNumberOfPath()
org.opendaylight.yangtools.yang.common.Uint8
getNumberOfPath()
UnicastBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Unicast>> augmentationType)
UnicastBuilder
setBgp(Bgp value)
UnicastBuilder
setIbgpNumberOfPath(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIbgpNumberOfPath(Uint8)} instead.UnicastBuilder
setIbgpNumberOfPath(org.opendaylight.yangtools.yang.common.Uint8 value)
UnicastBuilder
setNumberOfPath(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setNumberOfPath(Uint8)} instead.UnicastBuilder
setNumberOfPath(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
UnicastBuilder
public UnicastBuilder()
-
UnicastBuilder
public UnicastBuilder(MaximumPaths arg)
-
UnicastBuilder
public UnicastBuilder(Unicast 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:- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.MaximumPaths
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getBgp
public Bgp getBgp()
-
getIbgpNumberOfPath
public org.opendaylight.yangtools.yang.common.Uint8 getIbgpNumberOfPath()
-
getNumberOfPath
public org.opendaylight.yangtools.yang.common.Uint8 getNumberOfPath()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Unicast>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setBgp
public UnicastBuilder setBgp(Bgp value)
-
setIbgpNumberOfPath
public UnicastBuilder setIbgpNumberOfPath(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setIbgpNumberOfPath
@Deprecated(forRemoval=true) public UnicastBuilder setIbgpNumberOfPath(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIbgpNumberOfPath(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setNumberOfPath
public UnicastBuilder setNumberOfPath(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setNumberOfPath
@Deprecated(forRemoval=true) public UnicastBuilder setNumberOfPath(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setNumberOfPath(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public UnicastBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Unicast>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Unicast> augmentationValue)
-
removeAugmentation
public UnicastBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Unicast>> augmentationType)
-
-