Class MulticastBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.vpnv4.MulticastBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Multicast>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Multicast,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MulticastBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Multicast>
Class that buildsMulticastBuilder
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:
MulticastBuilder createTarget(int fooXyzzy, int barBaz) { return new MulticastBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MulticastBuilder, 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:
MulticastBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MulticastBuilder()
MulticastBuilder(Multicast base)
MulticastBuilder(MaximumPaths arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MulticastBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Multicast> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Multicast
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()
MulticastBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> augmentationType)
Remove an augmentation from this builder's product.MulticastBuilder
setBgp(Bgp value)
MulticastBuilder
setIbgpNumberOfPath(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIbgpNumberOfPath(Uint8)
instead.MulticastBuilder
setIbgpNumberOfPath(org.opendaylight.yangtools.yang.common.Uint8 value)
MulticastBuilder
setNumberOfPath(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetNumberOfPath(Uint8)
instead.MulticastBuilder
setNumberOfPath(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
MulticastBuilder
public MulticastBuilder()
-
MulticastBuilder
public MulticastBuilder(MaximumPaths arg)
-
MulticastBuilder
public MulticastBuilder(Multicast 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 or has property with incompatible value
-
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<Multicast>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setBgp
public MulticastBuilder setBgp(Bgp value)
-
setIbgpNumberOfPath
public MulticastBuilder setIbgpNumberOfPath(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setIbgpNumberOfPath
@Deprecated(forRemoval=true) public MulticastBuilder setIbgpNumberOfPath(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIbgpNumberOfPath(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setNumberOfPath
public MulticastBuilder setNumberOfPath(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setNumberOfPath
@Deprecated(forRemoval=true) public MulticastBuilder setNumberOfPath(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetNumberOfPath(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public MulticastBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Multicast> 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 MulticastBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> 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
-
-