Class MeterModInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MeterModInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MeterModInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MeterModInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MeterModInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MeterModInput>
Class that buildsMeterModInputBuilder
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:
MeterModInputBuilder createTarget(int fooXyzzy, int barBaz) { return new MeterModInputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterModInputBuilder, 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:
MeterModInputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MeterModInputBuilder()
MeterModInputBuilder(MeterMod arg)
MeterModInputBuilder(MeterModInput base)
MeterModInputBuilder(OfHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MeterModInputBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterModInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MeterModInput> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterModInput>>
E$$augmentation(Class<E$$> augmentationType)
MeterModInput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Bands>
getBands()
MeterModCommand
getCommand()
MeterFlags
getFlags()
MeterId
getMeterId()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
MeterModInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterModInput>> augmentationType)
MeterModInputBuilder
setBands(List<Bands> values)
MeterModInputBuilder
setCommand(MeterModCommand value)
MeterModInputBuilder
setFlags(MeterFlags value)
MeterModInputBuilder
setMeterId(MeterId value)
MeterModInputBuilder
setVersion(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVersion(Uint8)} instead.MeterModInputBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
MeterModInputBuilder
setXid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setXid(Uint32)} instead.MeterModInputBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
MeterModInputBuilder
public MeterModInputBuilder()
-
MeterModInputBuilder
public MeterModInputBuilder(MeterMod arg)
-
MeterModInputBuilder
public MeterModInputBuilder(OfHeader arg)
-
MeterModInputBuilder
public MeterModInputBuilder(MeterModInput 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.openflow.protocol.rev130731.OfHeader
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MeterMod
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getCommand
public MeterModCommand getCommand()
-
getFlags
public MeterFlags getFlags()
-
getMeterId
public MeterId getMeterId()
-
getVersion
public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
-
getXid
public org.opendaylight.yangtools.yang.common.Uint32 getXid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterModInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setBands
public MeterModInputBuilder setBands(List<Bands> values)
-
setCommand
public MeterModInputBuilder setCommand(MeterModCommand value)
-
setFlags
public MeterModInputBuilder setFlags(MeterFlags value)
-
setMeterId
public MeterModInputBuilder setMeterId(MeterId value)
-
setVersion
public MeterModInputBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setVersion
@Deprecated(forRemoval=true) public MeterModInputBuilder setVersion(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVersion(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setXid
public MeterModInputBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setXid
@Deprecated(forRemoval=true) public MeterModInputBuilder setXid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setXid(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public MeterModInputBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterModInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MeterModInput> augmentationValue)
-
removeAugmentation
public MeterModInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterModInput>> augmentationType)
-
build
public MeterModInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MeterModInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MeterModInput,IllegalArgumentException>
-
-