Class BatchFailedMetersOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.batch.meter.output.list.grouping.BatchFailedMetersOutputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BatchFailedMetersOutput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BatchFailedMetersOutput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BatchFailedMetersOutputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BatchFailedMetersOutput>
Class that buildsBatchFailedMetersOutput
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:
BatchFailedMetersOutput createBatchFailedMetersOutput(int fooXyzzy, int barBaz) { return new BatchFailedMetersOutputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchFailedMetersOutput, 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:
BatchFailedMetersOutput
,Builder
-
-
Constructor Summary
Constructors Constructor Description BatchFailedMetersOutputBuilder()
BatchFailedMetersOutputBuilder(BatchFailedMetersOutput base)
BatchFailedMetersOutputBuilder(BatchOrderGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BatchFailedMetersOutputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedMetersOutput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedMetersOutput>>
E$$augmentation(Class<E$$> augmentationType)
BatchFailedMetersOutput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
MeterId
getMeterId()
BatchFailedMetersOutputKey
key()
BatchFailedMetersOutputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedMetersOutput>> augmentationType)
Remove an augmentation from this builder's product.BatchFailedMetersOutputBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
BatchFailedMetersOutputBuilder
setMeterId(MeterId value)
BatchFailedMetersOutputBuilder
withKey(BatchFailedMetersOutputKey key)
-
-
-
Constructor Detail
-
BatchFailedMetersOutputBuilder
public BatchFailedMetersOutputBuilder()
-
BatchFailedMetersOutputBuilder
public BatchFailedMetersOutputBuilder(BatchOrderGrouping arg)
-
BatchFailedMetersOutputBuilder
public BatchFailedMetersOutputBuilder(BatchFailedMetersOutput base)
-
-
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:- BatchOrderGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public BatchFailedMetersOutputKey key()
-
getBatchOrder
public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()
-
getMeterId
public MeterId getMeterId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedMetersOutput>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BatchFailedMetersOutputBuilder withKey(BatchFailedMetersOutputKey key)
-
setBatchOrder
public BatchFailedMetersOutputBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMeterId
public BatchFailedMetersOutputBuilder setMeterId(MeterId value)
-
addAugmentation
public BatchFailedMetersOutputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedMetersOutput> 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 BatchFailedMetersOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedMetersOutput>> 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
public BatchFailedMetersOutput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BatchFailedMetersOutput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BatchFailedMetersOutput,IllegalArgumentException>
-
-