Class ExplicitLocatorPathBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.ExplicitLocatorPathBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ExplicitLocatorPath>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ExplicitLocatorPath,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ExplicitLocatorPathBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<ExplicitLocatorPath>
Class that buildsExplicitLocatorPathBuilder
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:
ExplicitLocatorPathBuilder createTarget(int fooXyzzy, int barBaz) { return new ExplicitLocatorPathBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ExplicitLocatorPathBuilder, 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:
ExplicitLocatorPathBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ExplicitLocatorPathBuilder()
ExplicitLocatorPathBuilder(ExplicitLocatorPath base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExplicitLocatorPathBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExplicitLocatorPath> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExplicitLocatorPath>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
ExplicitLocatorPath
build()
ExplicitLocatorPath
getExplicitLocatorPath()
ExplicitLocatorPathBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExplicitLocatorPath>> augmentationType)
Remove an augmentation from this builder's product.ExplicitLocatorPathBuilder
setExplicitLocatorPath(ExplicitLocatorPath value)
-
-
-
Constructor Detail
-
ExplicitLocatorPathBuilder
public ExplicitLocatorPathBuilder()
-
ExplicitLocatorPathBuilder
public ExplicitLocatorPathBuilder(ExplicitLocatorPath base)
-
-
Method Detail
-
getExplicitLocatorPath
public ExplicitLocatorPath getExplicitLocatorPath()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExplicitLocatorPath>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setExplicitLocatorPath
public ExplicitLocatorPathBuilder setExplicitLocatorPath(ExplicitLocatorPath value)
-
addAugmentation
public ExplicitLocatorPathBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExplicitLocatorPath> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public ExplicitLocatorPathBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExplicitLocatorPath>> 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 ExplicitLocatorPath build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ExplicitLocatorPath>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ExplicitLocatorPath,java.lang.IllegalArgumentException>
-
-