Class UnicastBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv4.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>
@Generated("mdsal-binding-generator") 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)
UnicastBuilder(Redistribute arg)
UnicastBuilder(RouterAfConfig arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description UnicastBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Unicast> augmentation)
Add an augmentation to this builder's product.<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.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getAggregateAddress()
java.lang.Boolean
getAutoSummary()
Bgp
getBgp()
org.opendaylight.yangtools.yang.common.Uint8
getDistance()
org.opendaylight.yangtools.yang.common.Uint8
getIbgpNumberOfPath()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getNetwork()
org.opendaylight.yangtools.yang.common.Uint8
getNumberOfPath()
Protocol
getProtocol()
java.lang.Boolean
getSynchronization()
java.lang.Boolean
isAutoSummary()
Deprecated, for removal: This API element is subject to removal in a future version.java.lang.Boolean
isSynchronization()
Deprecated, for removal: This API element is subject to removal in a future version.UnicastBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Unicast>> augmentationType)
Remove an augmentation from this builder's product.UnicastBuilder
setAggregateAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
UnicastBuilder
setAutoSummary(java.lang.Boolean value)
UnicastBuilder
setBgp(Bgp value)
UnicastBuilder
setDistance(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDistance(Uint8)
instead.UnicastBuilder
setDistance(org.opendaylight.yangtools.yang.common.Uint8 value)
UnicastBuilder
setIbgpNumberOfPath(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIbgpNumberOfPath(Uint8)
instead.UnicastBuilder
setIbgpNumberOfPath(org.opendaylight.yangtools.yang.common.Uint8 value)
UnicastBuilder
setNetwork(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
UnicastBuilder
setNumberOfPath(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetNumberOfPath(Uint8)
instead.UnicastBuilder
setNumberOfPath(org.opendaylight.yangtools.yang.common.Uint8 value)
UnicastBuilder
setProtocol(Protocol value)
UnicastBuilder
setSynchronization(java.lang.Boolean value)
-
-
-
Constructor Detail
-
UnicastBuilder
public UnicastBuilder()
-
UnicastBuilder
public UnicastBuilder(RouterAfConfig arg)
-
UnicastBuilder
public UnicastBuilder(Redistribute arg)
-
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.Redistribute
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.MaximumPaths
- 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 or has property with incompatible value
-
getAggregateAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAggregateAddress()
-
getAutoSummary
public java.lang.Boolean getAutoSummary()
-
isAutoSummary
@Deprecated(forRemoval=true) public final java.lang.Boolean isAutoSummary()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getBgp
public Bgp getBgp()
-
getDistance
public org.opendaylight.yangtools.yang.common.Uint8 getDistance()
-
getIbgpNumberOfPath
public org.opendaylight.yangtools.yang.common.Uint8 getIbgpNumberOfPath()
-
getNetwork
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getNetwork()
-
getNumberOfPath
public org.opendaylight.yangtools.yang.common.Uint8 getNumberOfPath()
-
getProtocol
public Protocol getProtocol()
-
getSynchronization
public java.lang.Boolean getSynchronization()
-
isSynchronization
@Deprecated(forRemoval=true) public final java.lang.Boolean isSynchronization()
Deprecated, for removal: This API element is subject to removal in a future version.
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Unicast>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setAggregateAddress
public UnicastBuilder setAggregateAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setAutoSummary
public UnicastBuilder setAutoSummary(java.lang.Boolean value)
-
setBgp
public UnicastBuilder setBgp(Bgp value)
-
setDistance
public UnicastBuilder setDistance(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setDistance
@Deprecated(forRemoval=true) public UnicastBuilder setDistance(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDistance(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
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.UsesetIbgpNumberOfPath(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setNetwork
public UnicastBuilder setNetwork(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
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.UsesetNumberOfPath(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setProtocol
public UnicastBuilder setProtocol(Protocol value)
-
setSynchronization
public UnicastBuilder setSynchronization(java.lang.Boolean value)
-
addAugmentation
public UnicastBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Unicast> 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 UnicastBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Unicast>> 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
-
-