Class RsvpErrorSpecBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.rsvp.error.spec.tlv.RsvpErrorSpecBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<RsvpErrorSpec>
,org.opendaylight.yangtools.concepts.CheckedBuilder<RsvpErrorSpec,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class RsvpErrorSpecBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<RsvpErrorSpec>
Class that buildsRsvpErrorSpec
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:
RsvpErrorSpec createRsvpErrorSpec(int fooXyzzy, int barBaz) { return new RsvpErrorSpecBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RsvpErrorSpec, 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:
RsvpErrorSpec
,Builder
-
-
Constructor Summary
Constructors Constructor Description RsvpErrorSpecBuilder()
RsvpErrorSpecBuilder(RsvpErrorSpec base)
RsvpErrorSpecBuilder(Tlv arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RsvpErrorSpecBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RsvpErrorSpec> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RsvpErrorSpec>>
E$$augmentation(Class<E$$> augmentationType)
RsvpErrorSpec
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ErrorType
getErrorType()
RsvpErrorSpecBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RsvpErrorSpec>> augmentationType)
Remove an augmentation from this builder's product.RsvpErrorSpecBuilder
setErrorType(ErrorType value)
-
-
-
Constructor Detail
-
RsvpErrorSpecBuilder
public RsvpErrorSpecBuilder()
-
RsvpErrorSpecBuilder
public RsvpErrorSpecBuilder(Tlv arg)
-
RsvpErrorSpecBuilder
public RsvpErrorSpecBuilder(RsvpErrorSpec 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:- Tlv
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getErrorType
public ErrorType getErrorType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RsvpErrorSpec>> E$$ augmentation(Class<E$$> augmentationType)
-
setErrorType
public RsvpErrorSpecBuilder setErrorType(ErrorType value)
-
addAugmentation
public RsvpErrorSpecBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RsvpErrorSpec> 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 RsvpErrorSpecBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RsvpErrorSpec>> 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 RsvpErrorSpec build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<RsvpErrorSpec>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<RsvpErrorSpec,IllegalArgumentException>
-
-