Class TedBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.isis.topology.rev131021.isis.link.attributes.isis.link.attributes.TedBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ted>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ted,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TedBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ted>
Class that buildsTed
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:
Ted createTed(int fooXyzzy, int barBaz) { return new TedBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ted, 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 opportunities, 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:
Ted
,Builder
-
-
Constructor Summary
Constructors Constructor Description TedBuilder()
TedBuilder(Ted base)
TedBuilder(TedLinkAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TedBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ted> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ted>>
E$$augmentation(Class<E$$> augmentationType)
Ted
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getColor()
BigDecimal
getMaxLinkBandwidth()
BigDecimal
getMaxResvLinkBandwidth()
Srlg
getSrlg()
org.opendaylight.yangtools.yang.common.Uint32
getTeDefaultMetric()
Map<UnreservedBandwidthKey,UnreservedBandwidth>
getUnreservedBandwidth()
TedBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ted>> augmentationType)
Remove an augmentation from this builder's product.TedBuilder
setColor(org.opendaylight.yangtools.yang.common.Uint32 value)
TedBuilder
setMaxLinkBandwidth(BigDecimal value)
TedBuilder
setMaxResvLinkBandwidth(BigDecimal value)
TedBuilder
setSrlg(Srlg value)
TedBuilder
setTeDefaultMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
TedBuilder
setUnreservedBandwidth(Map<UnreservedBandwidthKey,UnreservedBandwidth> values)
-
-
-
Constructor Detail
-
TedBuilder
public TedBuilder()
-
TedBuilder
public TedBuilder(TedLinkAttributes arg)
-
TedBuilder
public TedBuilder(Ted 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:- TedLinkAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getColor
public org.opendaylight.yangtools.yang.common.Uint32 getColor()
-
getMaxLinkBandwidth
public BigDecimal getMaxLinkBandwidth()
-
getMaxResvLinkBandwidth
public BigDecimal getMaxResvLinkBandwidth()
-
getSrlg
public Srlg getSrlg()
-
getTeDefaultMetric
public org.opendaylight.yangtools.yang.common.Uint32 getTeDefaultMetric()
-
getUnreservedBandwidth
public Map<UnreservedBandwidthKey,UnreservedBandwidth> getUnreservedBandwidth()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ted>> E$$ augmentation(Class<E$$> augmentationType)
-
setColor
public TedBuilder setColor(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMaxLinkBandwidth
public TedBuilder setMaxLinkBandwidth(BigDecimal value)
-
setMaxResvLinkBandwidth
public TedBuilder setMaxResvLinkBandwidth(BigDecimal value)
-
setSrlg
public TedBuilder setSrlg(Srlg value)
-
setTeDefaultMetric
public TedBuilder setTeDefaultMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setUnreservedBandwidth
public TedBuilder setUnreservedBandwidth(Map<UnreservedBandwidthKey,UnreservedBandwidth> values)
-
addAugmentation
public TedBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ted> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public TedBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ted>> 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
-
build
public Ted build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ted>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ted,IllegalArgumentException>
-
-