Class SegmentsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.sr.rev130819.sr.node.attributes.SegmentsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Segments>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Segments,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SegmentsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Segments>
Class that buildsSegments
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:
Segments createSegments(int fooXyzzy, int barBaz) { return new SegmentsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Segments, 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:
Segments
,Builder
-
-
Constructor Summary
Constructors Constructor Description SegmentsBuilder()
SegmentsBuilder(Segments base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SegmentsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Segments> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Segments>>
E$$augmentation(Class<E$$> augmentationType)
Segments
build()
SegmentId
getSegmentId()
SegmentSpecification
getSegmentSpecification()
SegmentsKey
key()
SegmentsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Segments>> augmentationType)
Remove an augmentation from this builder's product.SegmentsBuilder
setSegmentId(SegmentId value)
SegmentsBuilder
setSegmentSpecification(SegmentSpecification value)
SegmentsBuilder
withKey(SegmentsKey key)
-
-
-
Constructor Detail
-
SegmentsBuilder
public SegmentsBuilder()
-
SegmentsBuilder
public SegmentsBuilder(Segments base)
-
-
Method Detail
-
key
public SegmentsKey key()
-
getSegmentId
public SegmentId getSegmentId()
-
getSegmentSpecification
public SegmentSpecification getSegmentSpecification()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Segments>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public SegmentsBuilder withKey(SegmentsKey key)
-
setSegmentId
public SegmentsBuilder setSegmentId(SegmentId value)
-
setSegmentSpecification
public SegmentsBuilder setSegmentSpecification(SegmentSpecification value)
-
addAugmentation
public SegmentsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Segments> 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 SegmentsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Segments>> 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 Segments build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Segments>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Segments,IllegalArgumentException>
-
-