Class IdentifiableNodeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.topology.general.rev131030.IdentifiableNodeBuilder
-
- All Implemented Interfaces:
Builder<IdentifiableNode>
,CheckedBuilder<IdentifiableNode,IllegalArgumentException>
,Mutable
,MutationBehaviour<Mutable>
public class IdentifiableNodeBuilder extends Object implements Builder<IdentifiableNode>
Class that buildsIdentifiableNodeBuilder
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:
IdentifiableNodeBuilder createTarget(int fooXyzzy, int barBaz) { return new IdentifiableNodeBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IdentifiableNodeBuilder, 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:
IdentifiableNodeBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IdentifiableNodeBuilder()
IdentifiableNodeBuilder(IdentifiableNode base)
IdentifiableNodeBuilder(NodeIdentifiers arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IdentifiableNode
build()
void
fieldsFrom(DataObject arg)
Set fields from given grouping argument.Map<NodeIdentifierKey,NodeIdentifier>
getNodeIdentifier()
IdentifiableNodeBuilder
setNodeIdentifier(List<NodeIdentifier> values)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link #setNodeIdentifier(Map)} instead.IdentifiableNodeBuilder
setNodeIdentifier(Map<NodeIdentifierKey,NodeIdentifier> values)
-
-
-
Constructor Detail
-
IdentifiableNodeBuilder
public IdentifiableNodeBuilder()
-
IdentifiableNodeBuilder
public IdentifiableNodeBuilder(NodeIdentifiers arg)
-
IdentifiableNodeBuilder
public IdentifiableNodeBuilder(IdentifiableNode base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.model.topology.general.rev131030.NodeIdentifiers
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getNodeIdentifier
public Map<NodeIdentifierKey,NodeIdentifier> getNodeIdentifier()
-
setNodeIdentifier
public IdentifiableNodeBuilder setNodeIdentifier(Map<NodeIdentifierKey,NodeIdentifier> values)
-
setNodeIdentifier
@Deprecated(forRemoval=true) public IdentifiableNodeBuilder setNodeIdentifier(List<NodeIdentifier> values)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link #setNodeIdentifier(Map)} instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
build
public IdentifiableNode build()
- Specified by:
build
in interfaceBuilder<IdentifiableNode>
- Specified by:
build
in interfaceCheckedBuilder<IdentifiableNode,IllegalArgumentException>
-
-