Class RsvpErrorBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.rsvp.error.spec.tlv.rsvp.error.spec.error.type.rsvp._case.RsvpErrorBuilder
-
@Generated("mdsal-binding-generator") public class RsvpErrorBuilder extends Object
Class that buildsRsvpError
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:
RsvpError createRsvpError(int fooXyzzy, int barBaz) { return new RsvpErrorBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RsvpError, 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:
RsvpError
- 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
-
-
Constructor Summary
Constructors Constructor Description RsvpErrorBuilder()
Construct an empty builder.RsvpErrorBuilder(RsvpError base)
Construct a builder initialized with state from specifiedRsvpError
.RsvpErrorBuilder(ErrorSpec arg)
Construct a new builder initialized from specifiedErrorSpec
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RsvpErrorBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RsvpError> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RsvpError>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull RsvpError
build()
A newRsvpError
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getCode()
Return current value associated with the property corresponding toErrorSpec.getCode()
.ErrorSpec.Flags
getFlags()
Return current value associated with the property corresponding toErrorSpec.getFlags()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getNode()
Return current value associated with the property corresponding toErrorSpec.getNode()
.org.opendaylight.yangtools.yang.common.Uint16
getValue()
Return current value associated with the property corresponding toErrorSpec.getValue()
.RsvpErrorBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RsvpError>> augmentationType)
Remove an augmentation from this builder's product.RsvpErrorBuilder
setCode(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toErrorSpec.getCode()
to the specified value.RsvpErrorBuilder
setFlags(ErrorSpec.Flags value)
Set the property corresponding toErrorSpec.getFlags()
to the specified value.RsvpErrorBuilder
setNode(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toErrorSpec.getNode()
to the specified value.RsvpErrorBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toErrorSpec.getValue()
to the specified value.
-
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getCode
public org.opendaylight.yangtools.yang.common.Uint8 getCode()
Return current value associated with the property corresponding toErrorSpec.getCode()
.- Returns:
- current value
-
getFlags
public ErrorSpec.Flags getFlags()
Return current value associated with the property corresponding toErrorSpec.getFlags()
.- Returns:
- current value
-
getNode
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getNode()
Return current value associated with the property corresponding toErrorSpec.getNode()
.- Returns:
- current value
-
getValue
public org.opendaylight.yangtools.yang.common.Uint16 getValue()
Return current value associated with the property corresponding toErrorSpec.getValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RsvpError>> 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
-
setCode
public RsvpErrorBuilder setCode(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toErrorSpec.getCode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
public RsvpErrorBuilder setFlags(ErrorSpec.Flags value)
Set the property corresponding toErrorSpec.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
public RsvpErrorBuilder setNode(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toErrorSpec.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setValue
public RsvpErrorBuilder setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toErrorSpec.getValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RsvpErrorBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RsvpError> 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 RsvpErrorBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RsvpError>> 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
-
-