Class SpanBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces._interface.SpanBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Span>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Span,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class SpanBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Span>
Class that buildsSpanBuilder
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:
SpanBuilder createTarget(int fooXyzzy, int barBaz) { return new SpanBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SpanBuilder, 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:
SpanBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SpanBuilder()
SpanBuilder(Span base)
SpanBuilder(SpanAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SpanBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Span>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Span> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Span>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Span
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MirroredInterfaces
getMirroredInterfaces()
SpanBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Span>> augmentationType)
SpanBuilder
setMirroredInterfaces(MirroredInterfaces value)
-
-
-
Constructor Detail
-
SpanBuilder
public SpanBuilder()
-
SpanBuilder
public SpanBuilder(SpanAttributes arg)
-
SpanBuilder
public SpanBuilder(Span 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.SpanAttributes
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getMirroredInterfaces
public MirroredInterfaces getMirroredInterfaces()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Span>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setMirroredInterfaces
public SpanBuilder setMirroredInterfaces(MirroredInterfaces value)
-
addAugmentation
public SpanBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Span>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Span> augmentationValue)
-
removeAugmentation
public SpanBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Span>> augmentationType)
-
-