Class ReportedHopsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.p2p.rev130819.tunnel.p2p.path.oper.attributes.ReportedHopsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ReportedHops>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ReportedHops,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ReportedHopsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ReportedHops>
Class that buildsReportedHops
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:
ReportedHops createReportedHops(int fooXyzzy, int barBaz) { return new ReportedHopsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ReportedHops, 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:
ReportedHops
,Builder
-
-
Constructor Summary
Constructors Constructor Description ReportedHopsBuilder()
ReportedHopsBuilder(ReportedHops base)
ReportedHopsBuilder(TunnelP2pPathHops arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ReportedHopsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ReportedHops> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ReportedHops>>
E$$augmentation(Class<E$$> augmentationType)
ReportedHops
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getOrder()
ReportedHopsKey
key()
ReportedHopsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ReportedHops>> augmentationType)
Remove an augmentation from this builder's product.ReportedHopsBuilder
setOrder(org.opendaylight.yangtools.yang.common.Uint32 value)
ReportedHopsBuilder
withKey(ReportedHopsKey key)
-
-
-
Constructor Detail
-
ReportedHopsBuilder
public ReportedHopsBuilder()
-
ReportedHopsBuilder
public ReportedHopsBuilder(TunnelP2pPathHops arg)
-
ReportedHopsBuilder
public ReportedHopsBuilder(ReportedHops 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:- TunnelP2pPathHops
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public ReportedHopsKey key()
-
getOrder
public org.opendaylight.yangtools.yang.common.Uint32 getOrder()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ReportedHops>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public ReportedHopsBuilder withKey(ReportedHopsKey key)
-
setOrder
public ReportedHopsBuilder setOrder(org.opendaylight.yangtools.yang.common.Uint32 value)
-
addAugmentation
public ReportedHopsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ReportedHops> 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 ReportedHopsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ReportedHops>> 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 ReportedHops build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ReportedHops>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ReportedHops,IllegalArgumentException>
-
-