Class MeterModInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MeterModInputBuilder
-
@Generated("mdsal-binding-generator") public class MeterModInputBuilder extends Object
Class that buildsMeterModInput
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:
MeterModInput createMeterModInput(int fooXyzzy, int barBaz) { return new MeterModInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterModInput, 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:
MeterModInput
- 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
-
-
Constructor Summary
Constructors Constructor Description MeterModInputBuilder()
Construct an empty builder.MeterModInputBuilder(MeterMod$G arg)
Construct a new builder initialized from specifiedMeterMod$G
.MeterModInputBuilder(MeterModInput base)
Construct a builder initialized with state from specifiedMeterModInput
.MeterModInputBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MeterModInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterModInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterModInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MeterModInput
build()
A newMeterModInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Bands>
getBands()
Return current value associated with the property corresponding toMeterMod$G.getBands()
.MeterModCommand
getCommand()
Return current value associated with the property corresponding toMeterMod$G.getCommand()
.MeterFlags
getFlags()
Return current value associated with the property corresponding toMeterMod$G.getFlags()
.MeterId
getMeterId()
Return current value associated with the property corresponding toMeterMod$G.getMeterId()
.org.opendaylight.yangtools.yang.common.Uint8
getVersion()
Return current value associated with the property corresponding toOfHeader.getVersion()
.org.opendaylight.yangtools.yang.common.Uint32
getXid()
Return current value associated with the property corresponding toOfHeader.getXid()
.MeterModInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterModInput>> augmentationType)
Remove an augmentation from this builder's product.MeterModInputBuilder
setBands(List<Bands> values)
Set the property corresponding toMeterMod$G.getBands()
to the specified value.MeterModInputBuilder
setCommand(MeterModCommand value)
Set the property corresponding toMeterMod$G.getCommand()
to the specified value.MeterModInputBuilder
setFlags(MeterFlags value)
Set the property corresponding toMeterMod$G.getFlags()
to the specified value.MeterModInputBuilder
setMeterId(MeterId value)
Set the property corresponding toMeterMod$G.getMeterId()
to the specified value.MeterModInputBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.MeterModInputBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.
-
-
-
Constructor Detail
-
MeterModInputBuilder
public MeterModInputBuilder()
Construct an empty builder.
-
MeterModInputBuilder
public MeterModInputBuilder(MeterMod$G arg)
Construct a new builder initialized from specifiedMeterMod$G
.- Parameters:
arg
- MeterMod$G from which the builder should be initialized
-
MeterModInputBuilder
public MeterModInputBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.- Parameters:
arg
- OfHeader from which the builder should be initialized
-
MeterModInputBuilder
public MeterModInputBuilder(MeterModInput base)
Construct a builder initialized with state from specifiedMeterModInput
.- Parameters:
base
- MeterModInput from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBands
public List<Bands> getBands()
Return current value associated with the property corresponding toMeterMod$G.getBands()
.- Returns:
- current value
-
getCommand
public MeterModCommand getCommand()
Return current value associated with the property corresponding toMeterMod$G.getCommand()
.- Returns:
- current value
-
getFlags
public MeterFlags getFlags()
Return current value associated with the property corresponding toMeterMod$G.getFlags()
.- Returns:
- current value
-
getMeterId
public MeterId getMeterId()
Return current value associated with the property corresponding toMeterMod$G.getMeterId()
.- Returns:
- current value
-
getVersion
public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
Return current value associated with the property corresponding toOfHeader.getVersion()
.- Returns:
- current value
-
getXid
public org.opendaylight.yangtools.yang.common.Uint32 getXid()
Return current value associated with the property corresponding toOfHeader.getXid()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterModInput>> 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
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setBands
public MeterModInputBuilder setBands(List<Bands> values)
Set the property corresponding toMeterMod$G.getBands()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setCommand
public MeterModInputBuilder setCommand(MeterModCommand value)
Set the property corresponding toMeterMod$G.getCommand()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
public MeterModInputBuilder setFlags(MeterFlags value)
Set the property corresponding toMeterMod$G.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterId
public MeterModInputBuilder setMeterId(MeterId value)
Set the property corresponding toMeterMod$G.getMeterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
public MeterModInputBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXid
public MeterModInputBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MeterModInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterModInput> 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 MeterModInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterModInput>> 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 @NonNull MeterModInput build()
A newMeterModInput
instance.- Returns:
- A new
MeterModInput
instance.
-
-