Class LinkDiscoveredBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.LinkDiscoveredBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<LinkDiscovered>
,org.opendaylight.yangtools.concepts.CheckedBuilder<LinkDiscovered,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LinkDiscoveredBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<LinkDiscovered>
Class that buildsLinkDiscovered
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:
LinkDiscovered createLinkDiscovered(int fooXyzzy, int barBaz) { return new LinkDiscoveredBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LinkDiscovered, 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:
LinkDiscovered
,Builder
-
-
Constructor Summary
Constructors Constructor Description LinkDiscoveredBuilder()
LinkDiscoveredBuilder(Link arg)
LinkDiscoveredBuilder(LinkDiscovered base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LinkDiscoveredBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LinkDiscovered> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkDiscovered>>
E$$augmentation(Class<E$$> augmentationType)
LinkDiscovered
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NodeConnectorRef
getDestination()
NodeConnectorRef
getSource()
LinkDiscoveredBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkDiscovered>> augmentationType)
Remove an augmentation from this builder's product.LinkDiscoveredBuilder
setDestination(NodeConnectorRef value)
LinkDiscoveredBuilder
setSource(NodeConnectorRef value)
-
-
-
Constructor Detail
-
LinkDiscoveredBuilder
public LinkDiscoveredBuilder()
-
LinkDiscoveredBuilder
public LinkDiscoveredBuilder(Link arg)
-
LinkDiscoveredBuilder
public LinkDiscoveredBuilder(LinkDiscovered 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:- Link
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getDestination
public NodeConnectorRef getDestination()
-
getSource
public NodeConnectorRef getSource()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkDiscovered>> E$$ augmentation(Class<E$$> augmentationType)
-
setDestination
public LinkDiscoveredBuilder setDestination(NodeConnectorRef value)
-
setSource
public LinkDiscoveredBuilder setSource(NodeConnectorRef value)
-
addAugmentation
public LinkDiscoveredBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LinkDiscovered> 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 LinkDiscoveredBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkDiscovered>> 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 LinkDiscovered build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<LinkDiscovered>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<LinkDiscovered,IllegalArgumentException>
-
-