Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124
Class AddBundleMessagesInputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesInputBuilder
Class that builds
AddBundleMessagesInput
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:
AddBundleMessagesInput createAddBundleMessagesInput(int fooXyzzy, int barBaz) {
return new AddBundleMessagesInputBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of AddBundleMessagesInput, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedNodeContextRef
.Construct a builder initialized with state from specifiedAddBundleMessagesInput
.Construct a new builder initialized from specifiedBundleCommonGrouping
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<AddBundleMessagesInput> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddBundleMessagesInput>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull AddBundleMessagesInput
build()
A newAddBundleMessagesInput
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toBundleCommonGrouping.getBundleId()
.Return current value associated with the property corresponding toBundleCommonGrouping.getBundleProperty()
.getFlags()
Return current value associated with the property corresponding toBundleCommonGrouping.getFlags()
.Return current value associated with the property corresponding toAddBundleMessagesInput.getMessages()
.getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddBundleMessagesInput>> augmentationType) Remove an augmentation from this builder's product.setBundleId
(BundleId value) Set the property corresponding toBundleCommonGrouping.getBundleId()
to the specified value.setBundleProperty
(List<BundleProperty> values) Set the property corresponding toBundleCommonGrouping.getBundleProperty()
to the specified value.setFlags
(BundleFlags value) Set the property corresponding toBundleCommonGrouping.getFlags()
to the specified value.setMessages
(Messages value) Set the property corresponding toAddBundleMessagesInput.getMessages()
to the specified value.Set the property corresponding toNodeContextRef.getNode()
to the specified value.
-
Constructor Details
-
AddBundleMessagesInputBuilder
public AddBundleMessagesInputBuilder()Construct an empty builder. -
AddBundleMessagesInputBuilder
Construct a new builder initialized from specifiedNodeContextRef
.- Parameters:
arg
- NodeContextRef from which the builder should be initialized
-
AddBundleMessagesInputBuilder
Construct a new builder initialized from specifiedBundleCommonGrouping
.- Parameters:
arg
- BundleCommonGrouping from which the builder should be initialized
-
AddBundleMessagesInputBuilder
Construct a builder initialized with state from specifiedAddBundleMessagesInput
.- Parameters:
base
- AddBundleMessagesInput 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
-
getBundleId
Return current value associated with the property corresponding toBundleCommonGrouping.getBundleId()
.- Returns:
- current value
-
getBundleProperty
Return current value associated with the property corresponding toBundleCommonGrouping.getBundleProperty()
.- Returns:
- current value
-
getFlags
Return current value associated with the property corresponding toBundleCommonGrouping.getFlags()
.- Returns:
- current value
-
getMessages
Return current value associated with the property corresponding toAddBundleMessagesInput.getMessages()
.- Returns:
- current value
-
getNode
Return current value associated with the property corresponding toNodeContextRef.getNode()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddBundleMessagesInput>> 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
-
setBundleId
Set the property corresponding toBundleCommonGrouping.getBundleId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBundleProperty
Set the property corresponding toBundleCommonGrouping.getBundleProperty()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setFlags
Set the property corresponding toBundleCommonGrouping.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMessages
Set the property corresponding toAddBundleMessagesInput.getMessages()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
Set the property corresponding toNodeContextRef.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public AddBundleMessagesInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AddBundleMessagesInput> 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 AddBundleMessagesInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddBundleMessagesInput>> 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 newAddBundleMessagesInput
instance.- Returns:
- A new
AddBundleMessagesInput
instance.
-