Class LinkOverutilizedBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.LinkOverutilizedBuilder
-
@Generated("mdsal-binding-generator") public class LinkOverutilizedBuilder extends Object
Class that buildsLinkOverutilized
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:
LinkOverutilized createLinkOverutilized(int fooXyzzy, int barBaz) { return new LinkOverutilizedBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LinkOverutilized, 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:
LinkOverutilized
- 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
-
-
Constructor Summary
Constructors Constructor Description LinkOverutilizedBuilder()
Construct an empty builder.LinkOverutilizedBuilder(Link arg)
Construct a new builder initialized from specifiedLink
.LinkOverutilizedBuilder(LinkOverutilized base)
Construct a builder initialized with state from specifiedLinkOverutilized
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LinkOverutilizedBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LinkOverutilized> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkOverutilized>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull LinkOverutilized
build()
A newLinkOverutilized
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NodeConnectorRef
getDestination()
Return current value associated with the property corresponding toLink.getDestination()
.NodeConnectorRef
getSource()
Return current value associated with the property corresponding toLink.getSource()
.LinkOverutilizedBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkOverutilized>> augmentationType)
Remove an augmentation from this builder's product.LinkOverutilizedBuilder
setDestination(NodeConnectorRef value)
Set the property corresponding toLink.getDestination()
to the specified value.LinkOverutilizedBuilder
setSource(NodeConnectorRef value)
Set the property corresponding toLink.getSource()
to the specified value.
-
-
-
Constructor Detail
-
LinkOverutilizedBuilder
public LinkOverutilizedBuilder()
Construct an empty builder.
-
LinkOverutilizedBuilder
public LinkOverutilizedBuilder(Link arg)
Construct a new builder initialized from specifiedLink
.- Parameters:
arg
- Link from which the builder should be initialized
-
LinkOverutilizedBuilder
public LinkOverutilizedBuilder(LinkOverutilized base)
Construct a builder initialized with state from specifiedLinkOverutilized
.- Parameters:
base
- LinkOverutilized from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getDestination
public NodeConnectorRef getDestination()
Return current value associated with the property corresponding toLink.getDestination()
.- Returns:
- current value
-
getSource
public NodeConnectorRef getSource()
Return current value associated with the property corresponding toLink.getSource()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkOverutilized>> 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
-
setDestination
public LinkOverutilizedBuilder setDestination(NodeConnectorRef value)
Set the property corresponding toLink.getDestination()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSource
public LinkOverutilizedBuilder setSource(NodeConnectorRef value)
Set the property corresponding toLink.getSource()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LinkOverutilizedBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LinkOverutilized> 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 LinkOverutilizedBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkOverutilized>> 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 @NonNull LinkOverutilized build()
A newLinkOverutilized
instance.- Returns:
- A new
LinkOverutilized
instance.
-
-