Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.admin.status.object
Class AdminStatusObjectBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.admin.status.object.AdminStatusObjectBuilder
Class that builds
AdminStatusObject
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:
AdminStatusObject createAdminStatusObject(int fooXyzzy, int barBaz) {
return new AdminStatusObjectBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of AdminStatusObject, 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 builder initialized with state from specifiedAdminStatusObject
.Construct a new builder initialized from specifiedRsvpTeObject
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<AdminStatusObject> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AdminStatusObject>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull AdminStatusObject
build()
A newAdminStatusObject
instance.static @NonNull AdminStatusObject
empty()
Get empty instance of AdminStatusObject.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toAdminStatusObject.getAdministrativelyDown()
.Return current value associated with the property corresponding toAdminStatusObject.getDeletionInProgress()
.Return current value associated with the property corresponding toAdminStatusObject.getReflect()
.Return current value associated with the property corresponding toAdminStatusObject.getTesting()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AdminStatusObject>> augmentationType) Remove an augmentation from this builder's product.setAdministrativelyDown
(Boolean value) Set the property corresponding toAdminStatusObject.getAdministrativelyDown()
to the specified value.setDeletionInProgress
(Boolean value) Set the property corresponding toAdminStatusObject.getDeletionInProgress()
to the specified value.setReflect
(Boolean value) Set the property corresponding toAdminStatusObject.getReflect()
to the specified value.setTesting
(Boolean value) Set the property corresponding toAdminStatusObject.getTesting()
to the specified value.
-
Constructor Details
-
AdminStatusObjectBuilder
public AdminStatusObjectBuilder()Construct an empty builder. -
AdminStatusObjectBuilder
Construct a new builder initialized from specifiedRsvpTeObject
.- Parameters:
arg
- RsvpTeObject from which the builder should be initialized
-
AdminStatusObjectBuilder
Construct a builder initialized with state from specifiedAdminStatusObject
.- Parameters:
base
- AdminStatusObject 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
-
empty
Get empty instance of AdminStatusObject.- Returns:
- An empty
AdminStatusObject
-
getAdministrativelyDown
Return current value associated with the property corresponding toAdminStatusObject.getAdministrativelyDown()
.- Returns:
- current value
-
getDeletionInProgress
Return current value associated with the property corresponding toAdminStatusObject.getDeletionInProgress()
.- Returns:
- current value
-
getReflect
Return current value associated with the property corresponding toAdminStatusObject.getReflect()
.- Returns:
- current value
-
getTesting
Return current value associated with the property corresponding toAdminStatusObject.getTesting()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AdminStatusObject>> 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
-
setAdministrativelyDown
Set the property corresponding toAdminStatusObject.getAdministrativelyDown()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDeletionInProgress
Set the property corresponding toAdminStatusObject.getDeletionInProgress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReflect
Set the property corresponding toAdminStatusObject.getReflect()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTesting
Set the property corresponding toAdminStatusObject.getTesting()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public AdminStatusObjectBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AdminStatusObject> 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 AdminStatusObjectBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AdminStatusObject>> 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 newAdminStatusObject
instance.- Returns:
- A new
AdminStatusObject
instance.
-