Class FlowModOutputToPortBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.flow.mod.spec.flow.mod.spec.flow.mod.output.to.port._case.FlowModOutputToPortBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlowModOutputToPort>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlowModOutputToPort,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlowModOutputToPortBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowModOutputToPort>
Class that buildsFlowModOutputToPortBuilder
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:
FlowModOutputToPortBuilder createTarget(int fooXyzzy, int barBaz) { return new FlowModOutputToPortBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowModOutputToPortBuilder, 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:
FlowModOutputToPortBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowModOutputToPortBuilder()
FlowModOutputToPortBuilder(FlowModOutputToPort base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FlowModOutputToPortBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowModOutputToPort> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModOutputToPort>>
E$$augmentation(Class<E$$> augmentationType)
FlowModOutputToPort
build()
org.opendaylight.yangtools.yang.common.Uint16
getFlowModNumBits()
org.opendaylight.yangtools.yang.common.Uint32
getSrcField()
org.opendaylight.yangtools.yang.common.Uint16
getSrcOfs()
FlowModOutputToPortBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModOutputToPort>> augmentationType)
Remove an augmentation from this builder's product.FlowModOutputToPortBuilder
setFlowModNumBits(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetFlowModNumBits(Uint16)
instead.FlowModOutputToPortBuilder
setFlowModNumBits(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowModOutputToPortBuilder
setSrcField(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSrcField(Uint32)
instead.FlowModOutputToPortBuilder
setSrcField(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowModOutputToPortBuilder
setSrcOfs(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSrcOfs(Uint16)
instead.FlowModOutputToPortBuilder
setSrcOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
FlowModOutputToPortBuilder
public FlowModOutputToPortBuilder()
-
FlowModOutputToPortBuilder
public FlowModOutputToPortBuilder(FlowModOutputToPort base)
-
-
Method Detail
-
getFlowModNumBits
public org.opendaylight.yangtools.yang.common.Uint16 getFlowModNumBits()
-
getSrcField
public org.opendaylight.yangtools.yang.common.Uint32 getSrcField()
-
getSrcOfs
public org.opendaylight.yangtools.yang.common.Uint16 getSrcOfs()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModOutputToPort>> E$$ augmentation(Class<E$$> augmentationType)
-
setFlowModNumBits
public FlowModOutputToPortBuilder setFlowModNumBits(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setFlowModNumBits
@Deprecated(forRemoval=true) public FlowModOutputToPortBuilder setFlowModNumBits(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetFlowModNumBits(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setSrcField
public FlowModOutputToPortBuilder setSrcField(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSrcField
@Deprecated(forRemoval=true) public FlowModOutputToPortBuilder setSrcField(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSrcField(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setSrcOfs
public FlowModOutputToPortBuilder setSrcOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setSrcOfs
@Deprecated(forRemoval=true) public FlowModOutputToPortBuilder setSrcOfs(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSrcOfs(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public FlowModOutputToPortBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowModOutputToPort> 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 FlowModOutputToPortBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModOutputToPort>> 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 FlowModOutputToPort build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowModOutputToPort>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowModOutputToPort,IllegalArgumentException>
-
-