Class MeterMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterMessageBuilder
-
@Generated("mdsal-binding-generator") public class MeterMessageBuilder extends Object
Class that buildsMeterMessage
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:
MeterMessage createMeterMessage(int fooXyzzy, int barBaz) { return new MeterMessageBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterMessage, 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:
MeterMessage
- 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 MeterMessageBuilder()
Construct an empty builder.MeterMessageBuilder(Meter arg)
Construct a new builder initialized from specifiedMeter
.MeterMessageBuilder(MeterMessage base)
Construct a builder initialized with state from specifiedMeterMessage
.MeterMessageBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MeterMessageBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterMessage> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterMessage>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MeterMessage
build()
A newMeterMessage
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrier()
Return current value associated with the property corresponding toMeter.getBarrier()
.MeterModCommand
getCommand()
Return current value associated with the property corresponding toMeterMessage.getCommand()
.String
getContainerName()
Return current value associated with the property corresponding toMeter.getContainerName()
.MeterFlags
getFlags()
Return current value associated with the property corresponding toMeter.getFlags()
.MeterBandHeaders
getMeterBandHeaders()
Return current value associated with the property corresponding toMeter.getMeterBandHeaders()
.MeterId
getMeterId()
Return current value associated with the property corresponding toMeter.getMeterId()
.String
getMeterName()
Return current value associated with the property corresponding toMeter.getMeterName()
.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()
.MeterMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterMessage>> augmentationType)
Remove an augmentation from this builder's product.MeterMessageBuilder
setBarrier(Boolean value)
Set the property corresponding toMeter.getBarrier()
to the specified value.MeterMessageBuilder
setCommand(MeterModCommand value)
Set the property corresponding toMeterMessage.getCommand()
to the specified value.MeterMessageBuilder
setContainerName(String value)
Set the property corresponding toMeter.getContainerName()
to the specified value.MeterMessageBuilder
setFlags(MeterFlags value)
Set the property corresponding toMeter.getFlags()
to the specified value.MeterMessageBuilder
setMeterBandHeaders(MeterBandHeaders value)
Set the property corresponding toMeter.getMeterBandHeaders()
to the specified value.MeterMessageBuilder
setMeterId(MeterId value)
Set the property corresponding toMeter.getMeterId()
to the specified value.MeterMessageBuilder
setMeterName(String value)
Set the property corresponding toMeter.getMeterName()
to the specified value.MeterMessageBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.MeterMessageBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.
-
-
-
Constructor Detail
-
MeterMessageBuilder
public MeterMessageBuilder()
Construct an empty builder.
-
MeterMessageBuilder
public MeterMessageBuilder(Meter arg)
Construct a new builder initialized from specifiedMeter
.- Parameters:
arg
- Meter from which the builder should be initialized
-
MeterMessageBuilder
public MeterMessageBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.- Parameters:
arg
- OfHeader from which the builder should be initialized
-
MeterMessageBuilder
public MeterMessageBuilder(MeterMessage base)
Construct a builder initialized with state from specifiedMeterMessage
.- Parameters:
base
- MeterMessage 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
-
getBarrier
public Boolean getBarrier()
Return current value associated with the property corresponding toMeter.getBarrier()
.- Returns:
- current value
-
getCommand
public MeterModCommand getCommand()
Return current value associated with the property corresponding toMeterMessage.getCommand()
.- Returns:
- current value
-
getContainerName
public String getContainerName()
Return current value associated with the property corresponding toMeter.getContainerName()
.- Returns:
- current value
-
getFlags
public MeterFlags getFlags()
Return current value associated with the property corresponding toMeter.getFlags()
.- Returns:
- current value
-
getMeterBandHeaders
public MeterBandHeaders getMeterBandHeaders()
Return current value associated with the property corresponding toMeter.getMeterBandHeaders()
.- Returns:
- current value
-
getMeterId
public MeterId getMeterId()
Return current value associated with the property corresponding toMeter.getMeterId()
.- Returns:
- current value
-
getMeterName
public String getMeterName()
Return current value associated with the property corresponding toMeter.getMeterName()
.- 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<MeterMessage>> 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
-
setBarrier
public MeterMessageBuilder setBarrier(Boolean value)
Set the property corresponding toMeter.getBarrier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCommand
public MeterMessageBuilder setCommand(MeterModCommand value)
Set the property corresponding toMeterMessage.getCommand()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setContainerName
public MeterMessageBuilder setContainerName(String value)
Set the property corresponding toMeter.getContainerName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
public MeterMessageBuilder setFlags(MeterFlags value)
Set the property corresponding toMeter.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterBandHeaders
public MeterMessageBuilder setMeterBandHeaders(MeterBandHeaders value)
Set the property corresponding toMeter.getMeterBandHeaders()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterId
public MeterMessageBuilder setMeterId(MeterId value)
Set the property corresponding toMeter.getMeterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterName
public MeterMessageBuilder setMeterName(String value)
Set the property corresponding toMeter.getMeterName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
public MeterMessageBuilder 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 MeterMessageBuilder 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 MeterMessageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterMessage> 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 MeterMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterMessage>> 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 MeterMessage build()
A newMeterMessage
instance.- Returns:
- A new
MeterMessage
instance.
-
-