Class BatchFailedFlowsOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.output.list.grouping.BatchFailedFlowsOutputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BatchFailedFlowsOutput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BatchFailedFlowsOutput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BatchFailedFlowsOutputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BatchFailedFlowsOutput>
Class that buildsBatchFailedFlowsOutputBuilder
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:
BatchFailedFlowsOutputBuilder createTarget(int fooXyzzy, int barBaz) { return new BatchFailedFlowsOutputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchFailedFlowsOutputBuilder, 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 oportunities, 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:
BatchFailedFlowsOutputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BatchFailedFlowsOutputBuilder()
BatchFailedFlowsOutputBuilder(BatchFailedFlowsOutput base)
BatchFailedFlowsOutputBuilder(BatchFlowIdGrouping arg)
BatchFailedFlowsOutputBuilder(BatchOrderGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BatchFailedFlowsOutputBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedFlowsOutput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedFlowsOutput> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedFlowsOutput>>
E$$augmentation(Class<E$$> augmentationType)
BatchFailedFlowsOutput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
FlowId
getFlowId()
BatchFailedFlowsOutputKey
key()
BatchFailedFlowsOutputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedFlowsOutput>> augmentationType)
BatchFailedFlowsOutputBuilder
setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBatchOrder(Uint16)} instead.BatchFailedFlowsOutputBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
BatchFailedFlowsOutputBuilder
setFlowId(FlowId value)
BatchFailedFlowsOutputBuilder
withKey(BatchFailedFlowsOutputKey key)
-
-
-
Constructor Detail
-
BatchFailedFlowsOutputBuilder
public BatchFailedFlowsOutputBuilder()
-
BatchFailedFlowsOutputBuilder
public BatchFailedFlowsOutputBuilder(BatchOrderGrouping arg)
-
BatchFailedFlowsOutputBuilder
public BatchFailedFlowsOutputBuilder(BatchFlowIdGrouping arg)
-
BatchFailedFlowsOutputBuilder
public BatchFailedFlowsOutputBuilder(BatchFailedFlowsOutput 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.BatchFlowIdGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.service.batch.common.rev160322.BatchOrderGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public BatchFailedFlowsOutputKey key()
-
getBatchOrder
public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()
-
getFlowId
public FlowId getFlowId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedFlowsOutput>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BatchFailedFlowsOutputBuilder withKey(BatchFailedFlowsOutputKey key)
-
setBatchOrder
public BatchFailedFlowsOutputBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setBatchOrder
@Deprecated(forRemoval=true) public BatchFailedFlowsOutputBuilder setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBatchOrder(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setFlowId
public BatchFailedFlowsOutputBuilder setFlowId(FlowId value)
-
addAugmentation
public BatchFailedFlowsOutputBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedFlowsOutput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedFlowsOutput> augmentationValue)
-
removeAugmentation
public BatchFailedFlowsOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedFlowsOutput>> augmentationType)
-
build
public BatchFailedFlowsOutput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BatchFailedFlowsOutput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BatchFailedFlowsOutput,IllegalArgumentException>
-
-