Class MeterMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterMessageBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MeterMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MeterMessage,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MeterMessageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MeterMessage>
Class that buildsMeterMessageBuilder
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:
MeterMessageBuilder createTarget(int fooXyzzy, int barBaz) { return new MeterMessageBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterMessageBuilder, 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:
MeterMessageBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MeterMessageBuilder()
MeterMessageBuilder(Meter arg)
MeterMessageBuilder(MeterMessage base)
MeterMessageBuilder(OfHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MeterMessageBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MeterMessage> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterMessage>>
E$$augmentation(Class<E$$> augmentationType)
MeterMessage
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MeterModCommand
getCommand()
String
getContainerName()
MeterFlags
getFlags()
MeterBandHeaders
getMeterBandHeaders()
MeterId
getMeterId()
String
getMeterName()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
Boolean
isBarrier()
MeterMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterMessage>> augmentationType)
MeterMessageBuilder
setBarrier(Boolean value)
MeterMessageBuilder
setCommand(MeterModCommand value)
MeterMessageBuilder
setContainerName(String value)
MeterMessageBuilder
setFlags(MeterFlags value)
MeterMessageBuilder
setMeterBandHeaders(MeterBandHeaders value)
MeterMessageBuilder
setMeterId(MeterId value)
MeterMessageBuilder
setMeterName(String value)
MeterMessageBuilder
setVersion(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVersion(Uint8)} instead.MeterMessageBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
MeterMessageBuilder
setXid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setXid(Uint32)} instead.MeterMessageBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
MeterMessageBuilder
public MeterMessageBuilder()
-
MeterMessageBuilder
public MeterMessageBuilder(Meter arg)
-
MeterMessageBuilder
public MeterMessageBuilder(OfHeader arg)
-
MeterMessageBuilder
public MeterMessageBuilder(MeterMessage 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.meter.types.rev130918.Meter
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getCommand
public MeterModCommand getCommand()
-
getContainerName
public String getContainerName()
-
getFlags
public MeterFlags getFlags()
-
getMeterBandHeaders
public MeterBandHeaders getMeterBandHeaders()
-
getMeterId
public MeterId getMeterId()
-
getMeterName
public String getMeterName()
-
getVersion
public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
-
getXid
public org.opendaylight.yangtools.yang.common.Uint32 getXid()
-
isBarrier
public Boolean isBarrier()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterMessage>> E$$ augmentation(Class<E$$> augmentationType)
-
setCommand
public MeterMessageBuilder setCommand(MeterModCommand value)
-
setContainerName
public MeterMessageBuilder setContainerName(String value)
-
setFlags
public MeterMessageBuilder setFlags(MeterFlags value)
-
setMeterBandHeaders
public MeterMessageBuilder setMeterBandHeaders(MeterBandHeaders value)
-
setMeterId
public MeterMessageBuilder setMeterId(MeterId value)
-
setMeterName
public MeterMessageBuilder setMeterName(String value)
-
setVersion
public MeterMessageBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setVersion
@Deprecated(forRemoval=true) public MeterMessageBuilder 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 MeterMessageBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setXid
@Deprecated(forRemoval=true) public MeterMessageBuilder 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
-
setBarrier
public MeterMessageBuilder setBarrier(Boolean value)
-
addAugmentation
public MeterMessageBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MeterMessage> augmentationValue)
-
removeAugmentation
public MeterMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterMessage>> augmentationType)
-
build
public MeterMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MeterMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MeterMessage,IllegalArgumentException>
-
-