Class UserErrorBuilder
- 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.user._case.UserErrorBuilder
-
@Generated("mdsal-binding-generator") public class UserErrorBuilder extends Object
Class that buildsUserError
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:
UserError createUserError(int fooXyzzy, int barBaz) { return new UserErrorBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UserError, 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:
UserError
- 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 UserErrorBuilder()
Construct an empty builder.UserErrorBuilder(UserError base)
Construct a builder initialized with state from specifiedUserError
.UserErrorBuilder(UserErrorSpec arg)
Construct a new builder initialized from specifiedUserErrorSpec
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UserErrorBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UserError> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UserError>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull UserError
build()
A newUserError
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getDescription()
Return current value associated with the property corresponding toUserErrorSpec.getDescription()
.EnterpriseNumber
getEnterprise()
Return current value associated with the property corresponding toUserErrorSpec.getEnterprise()
.Subobjects
getSubobjects()
Return current value associated with the property corresponding toUserErrorSpec.getSubobjects()
.org.opendaylight.yangtools.yang.common.Uint8
getSubOrg()
Return current value associated with the property corresponding toUserErrorSpec.getSubOrg()
.org.opendaylight.yangtools.yang.common.Uint16
getValue()
Return current value associated with the property corresponding toUserErrorSpec.getValue()
.UserErrorBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UserError>> augmentationType)
Remove an augmentation from this builder's product.UserErrorBuilder
setDescription(String value)
Set the property corresponding toUserErrorSpec.getDescription()
to the specified value.UserErrorBuilder
setEnterprise(EnterpriseNumber value)
Set the property corresponding toUserErrorSpec.getEnterprise()
to the specified value.UserErrorBuilder
setSubobjects(Subobjects value)
Set the property corresponding toUserErrorSpec.getSubobjects()
to the specified value.UserErrorBuilder
setSubOrg(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toUserErrorSpec.getSubOrg()
to the specified value.UserErrorBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toUserErrorSpec.getValue()
to the specified value.
-
-
-
Constructor Detail
-
UserErrorBuilder
public UserErrorBuilder()
Construct an empty builder.
-
UserErrorBuilder
public UserErrorBuilder(UserErrorSpec arg)
Construct a new builder initialized from specifiedUserErrorSpec
.- Parameters:
arg
- UserErrorSpec from which the builder should be initialized
-
-
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
-
getDescription
public String getDescription()
Return current value associated with the property corresponding toUserErrorSpec.getDescription()
.- Returns:
- current value
-
getEnterprise
public EnterpriseNumber getEnterprise()
Return current value associated with the property corresponding toUserErrorSpec.getEnterprise()
.- Returns:
- current value
-
getSubOrg
public org.opendaylight.yangtools.yang.common.Uint8 getSubOrg()
Return current value associated with the property corresponding toUserErrorSpec.getSubOrg()
.- Returns:
- current value
-
getSubobjects
public Subobjects getSubobjects()
Return current value associated with the property corresponding toUserErrorSpec.getSubobjects()
.- Returns:
- current value
-
getValue
public org.opendaylight.yangtools.yang.common.Uint16 getValue()
Return current value associated with the property corresponding toUserErrorSpec.getValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UserError>> 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
-
setDescription
public UserErrorBuilder setDescription(String value)
Set the property corresponding toUserErrorSpec.getDescription()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEnterprise
public UserErrorBuilder setEnterprise(EnterpriseNumber value)
Set the property corresponding toUserErrorSpec.getEnterprise()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSubOrg
public UserErrorBuilder setSubOrg(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toUserErrorSpec.getSubOrg()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSubobjects
public UserErrorBuilder setSubobjects(Subobjects value)
Set the property corresponding toUserErrorSpec.getSubobjects()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setValue
public UserErrorBuilder setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toUserErrorSpec.getValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public UserErrorBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UserError> 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 UserErrorBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UserError>> 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
-
-