Class StartTestInputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.dsbenchmark.rev150105.StartTestInputBuilder
Class that builds
StartTestInput 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:
StartTestInput createStartTestInput(int fooXyzzy, int barBaz) {
return new StartTestInputBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of StartTestInput, 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 builder initialized with state from specifiedStartTestInput. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation(org.opendaylight.yangtools.binding.Augmentation<StartTestInput> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<StartTestInput>>
E$$augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull StartTestInputbuild()A newStartTestInputinstance.Return current value associated with the property corresponding toStartTestInput.getDataFormat().Return current value associated with the property corresponding toStartTestInput.getDataStore().org.opendaylight.yangtools.yang.common.Uint32Return current value associated with the property corresponding toStartTestInput.getInnerElements().org.opendaylight.yangtools.yang.common.Uint32Return current value associated with the property corresponding toStartTestInput.getListeners().Return current value associated with the property corresponding toStartTestInput.getOperation().org.opendaylight.yangtools.yang.common.Uint32Return current value associated with the property corresponding toStartTestInput.getOuterElements().org.opendaylight.yangtools.yang.common.Uint32Return current value associated with the property corresponding toStartTestInput.getPutsPerTx().Return current value associated with the property corresponding toStartTestInput.getTransactionType().removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<StartTestInput>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toStartTestInput.getDataFormat()to the specified value.Set the property corresponding toStartTestInput.getDataStore()to the specified value.setInnerElements(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toStartTestInput.getInnerElements()to the specified value.setListeners(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toStartTestInput.getListeners()to the specified value.Set the property corresponding toStartTestInput.getOperation()to the specified value.setOuterElements(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toStartTestInput.getOuterElements()to the specified value.setPutsPerTx(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toStartTestInput.getPutsPerTx()to the specified value.Set the property corresponding toStartTestInput.getTransactionType()to the specified value.
-
Constructor Details
-
StartTestInputBuilder
public StartTestInputBuilder()Construct an empty builder. -
StartTestInputBuilder
Construct a builder initialized with state from specifiedStartTestInput.- Parameters:
base- StartTestInput from which the builder should be initialized
-
-
Method Details
-
getDataFormat
Return current value associated with the property corresponding toStartTestInput.getDataFormat().- Returns:
- current value
-
getDataStore
Return current value associated with the property corresponding toStartTestInput.getDataStore().- Returns:
- current value
-
getInnerElements
public org.opendaylight.yangtools.yang.common.Uint32 getInnerElements()Return current value associated with the property corresponding toStartTestInput.getInnerElements().- Returns:
- current value
-
getListeners
public org.opendaylight.yangtools.yang.common.Uint32 getListeners()Return current value associated with the property corresponding toStartTestInput.getListeners().- Returns:
- current value
-
getOperation
Return current value associated with the property corresponding toStartTestInput.getOperation().- Returns:
- current value
-
getOuterElements
public org.opendaylight.yangtools.yang.common.Uint32 getOuterElements()Return current value associated with the property corresponding toStartTestInput.getOuterElements().- Returns:
- current value
-
getPutsPerTx
public org.opendaylight.yangtools.yang.common.Uint32 getPutsPerTx()Return current value associated with the property corresponding toStartTestInput.getPutsPerTx().- Returns:
- current value
-
getTransactionType
Return current value associated with the property corresponding toStartTestInput.getTransactionType().- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<StartTestInput>> 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
nullif not present - Throws:
NullPointerException- ifaugmentTypeisnull
-
setDataFormat
Set the property corresponding toStartTestInput.getDataFormat()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setDataStore
Set the property corresponding toStartTestInput.getDataStore()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInnerElements
Set the property corresponding toStartTestInput.getInnerElements()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setListeners
Set the property corresponding toStartTestInput.getListeners()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setOperation
Set the property corresponding toStartTestInput.getOperation()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setOuterElements
Set the property corresponding toStartTestInput.getOuterElements()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setPutsPerTx
Set the property corresponding toStartTestInput.getPutsPerTx()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setTransactionType
Set the property corresponding toStartTestInput.getTransactionType()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
addAugmentation
public StartTestInputBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<StartTestInput> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException- ifaugmentationis null
-
removeAugmentation
public StartTestInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<StartTestInput>> 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 newStartTestInputinstance.- Returns:
- A new
StartTestInputinstance.
-