Class WavebandSwitchingLabelBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.label.subobject.label.type.waveband.switching.label._case.WavebandSwitchingLabelBuilder
Class that builds
WavebandSwitchingLabel
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:
WavebandSwitchingLabel createWavebandSwitchingLabel(int fooXyzzy, int barBaz) {
return new WavebandSwitchingLabelBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of WavebandSwitchingLabel, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedCLabel
.Construct a builder initialized with state from specifiedWavebandSwitchingLabel
.Construct a new builder initialized from specifiedWavebandSwitchingLabel
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<WavebandSwitchingLabel> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<WavebandSwitchingLabel>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull WavebandSwitchingLabel
build()
A newWavebandSwitchingLabel
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toWavebandSwitchingLabel.getEndLabel()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toWavebandSwitchingLabel.getStartLabel()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toWavebandSwitchingLabel.getWavebandId()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<WavebandSwitchingLabel>> augmentationType) Remove an augmentation from this builder's product.setEndLabel
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toWavebandSwitchingLabel.getEndLabel()
to the specified value.setStartLabel
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toWavebandSwitchingLabel.getStartLabel()
to the specified value.setWavebandId
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toWavebandSwitchingLabel.getWavebandId()
to the specified value.
-
Constructor Details
-
WavebandSwitchingLabelBuilder
public WavebandSwitchingLabelBuilder()Construct an empty builder. -
WavebandSwitchingLabelBuilder
Construct a new builder initialized from specifiedWavebandSwitchingLabel
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.WavebandSwitchingLabel from which the builder should be initialized
-
WavebandSwitchingLabelBuilder
Construct a new builder initialized from specifiedCLabel
.- Parameters:
arg
- CLabel from which the builder should be initialized
-
WavebandSwitchingLabelBuilder
Construct a builder initialized with state from specifiedWavebandSwitchingLabel
.- Parameters:
base
- WavebandSwitchingLabel from which the builder should be initialized
-
-
Method Details
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getEndLabel
public org.opendaylight.yangtools.yang.common.Uint32 getEndLabel()Return current value associated with the property corresponding toWavebandSwitchingLabel.getEndLabel()
.- Returns:
- current value
-
getStartLabel
public org.opendaylight.yangtools.yang.common.Uint32 getStartLabel()Return current value associated with the property corresponding toWavebandSwitchingLabel.getStartLabel()
.- Returns:
- current value
-
getWavebandId
public org.opendaylight.yangtools.yang.common.Uint32 getWavebandId()Return current value associated with the property corresponding toWavebandSwitchingLabel.getWavebandId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<WavebandSwitchingLabel>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setEndLabel
public WavebandSwitchingLabelBuilder setEndLabel(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toWavebandSwitchingLabel.getEndLabel()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStartLabel
public WavebandSwitchingLabelBuilder setStartLabel(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toWavebandSwitchingLabel.getStartLabel()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setWavebandId
public WavebandSwitchingLabelBuilder setWavebandId(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toWavebandSwitchingLabel.getWavebandId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public WavebandSwitchingLabelBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<WavebandSwitchingLabel> 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 WavebandSwitchingLabelBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<WavebandSwitchingLabel>> 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
A newWavebandSwitchingLabel
instance.- Returns:
- A new
WavebandSwitchingLabel
instance.
-