Class TedBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.ospf.link.attributes.ospf.link.attributes.TedBuilder
Class that builds
Ted
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedTedLinkAttributes
.TedBuilder
(Ted base) Construct a builder initialized with state from specifiedTed
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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) Return the specified augmentation, if it is present in this builder.@NonNull Ted
build()
A newTed
instance.static @NonNull Ted
empty()
Get empty instance of Ted.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getColor()
Return current value associated with the property corresponding toTedLinkAttributes.getColor()
.org.opendaylight.yangtools.yang.common.Decimal64
Return current value associated with the property corresponding toTedLinkAttributes.getMaxLinkBandwidth()
.org.opendaylight.yangtools.yang.common.Decimal64
Return current value associated with the property corresponding toTedLinkAttributes.getMaxResvLinkBandwidth()
.getSrlg()
Return current value associated with the property corresponding toTedLinkAttributes.getSrlg()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toTedLinkAttributes.getTeDefaultMetric()
.Return current value associated with the property corresponding toTedLinkAttributes.getUnreservedBandwidth()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ted>> augmentationType) Remove an augmentation from this builder's product.setColor
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toTedLinkAttributes.getColor()
to the specified value.setMaxLinkBandwidth
(org.opendaylight.yangtools.yang.common.Decimal64 value) Set the property corresponding toTedLinkAttributes.getMaxLinkBandwidth()
to the specified value.setMaxResvLinkBandwidth
(org.opendaylight.yangtools.yang.common.Decimal64 value) Set the property corresponding toTedLinkAttributes.getMaxResvLinkBandwidth()
to the specified value.Set the property corresponding toTedLinkAttributes.getSrlg()
to the specified value.setTeDefaultMetric
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toTedLinkAttributes.getTeDefaultMetric()
to the specified value.Set the property corresponding toTedLinkAttributes.getUnreservedBandwidth()
to the specified value.
-
Constructor Details
-
TedBuilder
public TedBuilder()Construct an empty builder. -
TedBuilder
Construct a new builder initialized from specifiedTedLinkAttributes
.- Parameters:
arg
- TedLinkAttributes from which the builder should be initialized
-
TedBuilder
Construct a builder initialized with state from specifiedTed
.- Parameters:
base
- Ted from which the builder should be initialized
-
-
Method Details
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
empty
Get empty instance of Ted.- Returns:
- An empty
Ted
-
getColor
public org.opendaylight.yangtools.yang.common.Uint32 getColor()Return current value associated with the property corresponding toTedLinkAttributes.getColor()
.- Returns:
- current value
-
getMaxLinkBandwidth
public org.opendaylight.yangtools.yang.common.Decimal64 getMaxLinkBandwidth()Return current value associated with the property corresponding toTedLinkAttributes.getMaxLinkBandwidth()
.- Returns:
- current value
-
getMaxResvLinkBandwidth
public org.opendaylight.yangtools.yang.common.Decimal64 getMaxResvLinkBandwidth()Return current value associated with the property corresponding toTedLinkAttributes.getMaxResvLinkBandwidth()
.- Returns:
- current value
-
getSrlg
Return current value associated with the property corresponding toTedLinkAttributes.getSrlg()
.- Returns:
- current value
-
getTeDefaultMetric
public org.opendaylight.yangtools.yang.common.Uint32 getTeDefaultMetric()Return current value associated with the property corresponding toTedLinkAttributes.getTeDefaultMetric()
.- Returns:
- current value
-
getUnreservedBandwidth
Return current value associated with the property corresponding toTedLinkAttributes.getUnreservedBandwidth()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ted>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setColor
Set the property corresponding toTedLinkAttributes.getColor()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaxLinkBandwidth
Set the property corresponding toTedLinkAttributes.getMaxLinkBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaxResvLinkBandwidth
Set the property corresponding toTedLinkAttributes.getMaxResvLinkBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSrlg
Set the property corresponding toTedLinkAttributes.getSrlg()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTeDefaultMetric
Set the property corresponding toTedLinkAttributes.getTeDefaultMetric()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setUnreservedBandwidth
Set the property corresponding toTedLinkAttributes.getUnreservedBandwidth()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
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
A newTed
instance.- Returns:
- A new
Ted
instance.
-