Class RsvpErrorBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.rsvp.error.spec.tlv.rsvp.error.spec.error.type.rsvp._case.RsvpErrorBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<RsvpError>
,org.opendaylight.yangtools.concepts.CheckedBuilder<RsvpError,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class RsvpErrorBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<RsvpError>
Class that buildsRsvpErrorBuilder
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:
RsvpErrorBuilder createTarget(int fooXyzzy, int barBaz) { return new RsvpErrorBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RsvpErrorBuilder, 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:
RsvpErrorBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RsvpErrorBuilder()
RsvpErrorBuilder(RsvpError base)
RsvpErrorBuilder(ErrorSpec arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RsvpErrorBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RsvpError>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<RsvpError> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RsvpError>>
E$$augmentation(Class<E$$> augmentationType)
RsvpError
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getCode()
ErrorSpec.Flags
getFlags()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getNode()
org.opendaylight.yangtools.yang.common.Uint16
getValue()
RsvpErrorBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RsvpError>> augmentationType)
RsvpErrorBuilder
setCode(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setCode(Uint8)} instead.RsvpErrorBuilder
setCode(org.opendaylight.yangtools.yang.common.Uint8 value)
RsvpErrorBuilder
setFlags(ErrorSpec.Flags value)
RsvpErrorBuilder
setNode(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
RsvpErrorBuilder
setValue(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setValue(Uint16)} instead.RsvpErrorBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint16 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.ErrorSpec
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getCode
public org.opendaylight.yangtools.yang.common.Uint8 getCode()
-
getFlags
public ErrorSpec.Flags getFlags()
-
getNode
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getNode()
-
getValue
public org.opendaylight.yangtools.yang.common.Uint16 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RsvpError>> E$$ augmentation(Class<E$$> augmentationType)
-
setCode
public RsvpErrorBuilder setCode(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setCode
@Deprecated(forRemoval=true) public RsvpErrorBuilder setCode(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setCode(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setFlags
public RsvpErrorBuilder setFlags(ErrorSpec.Flags value)
-
setNode
public RsvpErrorBuilder setNode(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
-
setValue
public RsvpErrorBuilder setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setValue
@Deprecated(forRemoval=true) public RsvpErrorBuilder setValue(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setValue(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public RsvpErrorBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RsvpError>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<RsvpError> augmentationValue)
-
removeAugmentation
public RsvpErrorBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RsvpError>> augmentationType)
-
build
public RsvpError build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<RsvpError>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<RsvpError,IllegalArgumentException>
-
-