Class MulticastBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv6.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>
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(Redistribute arg)
MulticastBuilder(RouterAfConfig arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MulticastBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Multicast> augmentationValue)
<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.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getAggregateAddress()
Bgp
getBgp()
org.opendaylight.yangtools.yang.common.Uint8
getDistance()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getNetwork()
Protocol
getProtocol()
MulticastBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> augmentationType)
MulticastBuilder
setAggregateAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
MulticastBuilder
setBgp(Bgp value)
MulticastBuilder
setDistance(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDistance(Uint8)} instead.MulticastBuilder
setDistance(org.opendaylight.yangtools.yang.common.Uint8 value)
MulticastBuilder
setNetwork(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
MulticastBuilder
setProtocol(Protocol value)
-
-
-
Constructor Detail
-
MulticastBuilder
public MulticastBuilder()
-
MulticastBuilder
public MulticastBuilder(RouterAfConfig arg)
-
MulticastBuilder
public MulticastBuilder(Redistribute 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.Redistribute
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.RouterAfConfig
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getAggregateAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAggregateAddress()
-
getBgp
public Bgp getBgp()
-
getDistance
public org.opendaylight.yangtools.yang.common.Uint8 getDistance()
-
getNetwork
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getNetwork()
-
getProtocol
public Protocol getProtocol()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setAggregateAddress
public MulticastBuilder setAggregateAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setBgp
public MulticastBuilder setBgp(Bgp value)
-
setDistance
public MulticastBuilder setDistance(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setDistance
@Deprecated(forRemoval=true) public MulticastBuilder setDistance(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDistance(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setNetwork
public MulticastBuilder setNetwork(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setProtocol
public MulticastBuilder setProtocol(Protocol value)
-
addAugmentation
public MulticastBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Multicast> augmentationValue)
-
removeAugmentation
public MulticastBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Multicast>> augmentationType)
-
-