Class PortStatusMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessageBuilder
-
@Generated("mdsal-binding-generator") public class PortStatusMessageBuilder extends Object
Class that buildsPortStatusMessage
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:
PortStatusMessage createPortStatusMessage(int fooXyzzy, int barBaz) { return new PortStatusMessageBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PortStatusMessage, 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:
PortStatusMessage
- 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 PortStatusMessageBuilder()
Construct an empty builder.PortStatusMessageBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.PortStatusMessageBuilder(PortGrouping arg)
Construct a new builder initialized from specifiedPortGrouping
.PortStatusMessageBuilder(PortStatus arg)
Construct a new builder initialized from specifiedPortStatus
.PortStatusMessageBuilder(PortStatusMessage base)
Construct a builder initialized with state from specifiedPortStatusMessage
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PortStatusMessageBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortStatusMessage> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortStatusMessage>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PortStatusMessage
build()
A newPortStatusMessage
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.PortFeatures
getAdvertisedFeatures()
Return current value associated with the property corresponding toPortGrouping.getAdvertisedFeatures()
.PortFeaturesV10
getAdvertisedFeaturesV10()
Return current value associated with the property corresponding toPortGrouping.getAdvertisedFeaturesV10()
.PortConfig
getConfig()
Return current value associated with the property corresponding toPortGrouping.getConfig()
.PortConfigV10
getConfigV10()
Return current value associated with the property corresponding toPortGrouping.getConfigV10()
.PortFeatures
getCurrentFeatures()
Return current value associated with the property corresponding toPortGrouping.getCurrentFeatures()
.PortFeaturesV10
getCurrentFeaturesV10()
Return current value associated with the property corresponding toPortGrouping.getCurrentFeaturesV10()
.org.opendaylight.yangtools.yang.common.Uint32
getCurrSpeed()
Return current value associated with the property corresponding toPortGrouping.getCurrSpeed()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
getHwAddr()
Return current value associated with the property corresponding toPortGrouping.getHwAddr()
.org.opendaylight.yangtools.yang.common.Uint32
getMaxSpeed()
Return current value associated with the property corresponding toPortGrouping.getMaxSpeed()
.String
getName()
Return current value associated with the property corresponding toPortGrouping.getName()
.PortFeatures
getPeerFeatures()
Return current value associated with the property corresponding toPortGrouping.getPeerFeatures()
.PortFeaturesV10
getPeerFeaturesV10()
Return current value associated with the property corresponding toPortGrouping.getPeerFeaturesV10()
.org.opendaylight.yangtools.yang.common.Uint32
getPortNo()
Return current value associated with the property corresponding toPortGrouping.getPortNo()
.PortReason
getReason()
Return current value associated with the property corresponding toPortStatus.getReason()
.PortState
getState()
Return current value associated with the property corresponding toPortGrouping.getState()
.PortStateV10
getStateV10()
Return current value associated with the property corresponding toPortGrouping.getStateV10()
.PortFeatures
getSupportedFeatures()
Return current value associated with the property corresponding toPortGrouping.getSupportedFeatures()
.PortFeaturesV10
getSupportedFeaturesV10()
Return current value associated with the property corresponding toPortGrouping.getSupportedFeaturesV10()
.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()
.PortStatusMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortStatusMessage>> augmentationType)
Remove an augmentation from this builder's product.PortStatusMessageBuilder
setAdvertisedFeatures(PortFeatures value)
Set the property corresponding toPortGrouping.getAdvertisedFeatures()
to the specified value.PortStatusMessageBuilder
setAdvertisedFeaturesV10(PortFeaturesV10 value)
Set the property corresponding toPortGrouping.getAdvertisedFeaturesV10()
to the specified value.PortStatusMessageBuilder
setConfig(PortConfig value)
Set the property corresponding toPortGrouping.getConfig()
to the specified value.PortStatusMessageBuilder
setConfigV10(PortConfigV10 value)
Set the property corresponding toPortGrouping.getConfigV10()
to the specified value.PortStatusMessageBuilder
setCurrentFeatures(PortFeatures value)
Set the property corresponding toPortGrouping.getCurrentFeatures()
to the specified value.PortStatusMessageBuilder
setCurrentFeaturesV10(PortFeaturesV10 value)
Set the property corresponding toPortGrouping.getCurrentFeaturesV10()
to the specified value.PortStatusMessageBuilder
setCurrSpeed(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPortGrouping.getCurrSpeed()
to the specified value.PortStatusMessageBuilder
setHwAddr(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
Set the property corresponding toPortGrouping.getHwAddr()
to the specified value.PortStatusMessageBuilder
setMaxSpeed(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPortGrouping.getMaxSpeed()
to the specified value.PortStatusMessageBuilder
setName(String value)
Set the property corresponding toPortGrouping.getName()
to the specified value.PortStatusMessageBuilder
setPeerFeatures(PortFeatures value)
Set the property corresponding toPortGrouping.getPeerFeatures()
to the specified value.PortStatusMessageBuilder
setPeerFeaturesV10(PortFeaturesV10 value)
Set the property corresponding toPortGrouping.getPeerFeaturesV10()
to the specified value.PortStatusMessageBuilder
setPortNo(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPortGrouping.getPortNo()
to the specified value.PortStatusMessageBuilder
setReason(PortReason value)
Set the property corresponding toPortStatus.getReason()
to the specified value.PortStatusMessageBuilder
setState(PortState value)
Set the property corresponding toPortGrouping.getState()
to the specified value.PortStatusMessageBuilder
setStateV10(PortStateV10 value)
Set the property corresponding toPortGrouping.getStateV10()
to the specified value.PortStatusMessageBuilder
setSupportedFeatures(PortFeatures value)
Set the property corresponding toPortGrouping.getSupportedFeatures()
to the specified value.PortStatusMessageBuilder
setSupportedFeaturesV10(PortFeaturesV10 value)
Set the property corresponding toPortGrouping.getSupportedFeaturesV10()
to the specified value.PortStatusMessageBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.PortStatusMessageBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.
-
-
-
Constructor Detail
-
PortStatusMessageBuilder
public PortStatusMessageBuilder()
Construct an empty builder.
-
PortStatusMessageBuilder
public PortStatusMessageBuilder(PortStatus arg)
Construct a new builder initialized from specifiedPortStatus
.- Parameters:
arg
- PortStatus from which the builder should be initialized
-
PortStatusMessageBuilder
public PortStatusMessageBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.- Parameters:
arg
- OfHeader from which the builder should be initialized
-
PortStatusMessageBuilder
public PortStatusMessageBuilder(PortGrouping arg)
Construct a new builder initialized from specifiedPortGrouping
.- Parameters:
arg
- PortGrouping from which the builder should be initialized
-
PortStatusMessageBuilder
public PortStatusMessageBuilder(PortStatusMessage base)
Construct a builder initialized with state from specifiedPortStatusMessage
.- Parameters:
base
- PortStatusMessage 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
-
getAdvertisedFeatures
public PortFeatures getAdvertisedFeatures()
Return current value associated with the property corresponding toPortGrouping.getAdvertisedFeatures()
.- Returns:
- current value
-
getAdvertisedFeaturesV10
public PortFeaturesV10 getAdvertisedFeaturesV10()
Return current value associated with the property corresponding toPortGrouping.getAdvertisedFeaturesV10()
.- Returns:
- current value
-
getConfig
public PortConfig getConfig()
Return current value associated with the property corresponding toPortGrouping.getConfig()
.- Returns:
- current value
-
getConfigV10
public PortConfigV10 getConfigV10()
Return current value associated with the property corresponding toPortGrouping.getConfigV10()
.- Returns:
- current value
-
getCurrSpeed
public org.opendaylight.yangtools.yang.common.Uint32 getCurrSpeed()
Return current value associated with the property corresponding toPortGrouping.getCurrSpeed()
.- Returns:
- current value
-
getCurrentFeatures
public PortFeatures getCurrentFeatures()
Return current value associated with the property corresponding toPortGrouping.getCurrentFeatures()
.- Returns:
- current value
-
getCurrentFeaturesV10
public PortFeaturesV10 getCurrentFeaturesV10()
Return current value associated with the property corresponding toPortGrouping.getCurrentFeaturesV10()
.- Returns:
- current value
-
getHwAddr
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getHwAddr()
Return current value associated with the property corresponding toPortGrouping.getHwAddr()
.- Returns:
- current value
-
getMaxSpeed
public org.opendaylight.yangtools.yang.common.Uint32 getMaxSpeed()
Return current value associated with the property corresponding toPortGrouping.getMaxSpeed()
.- Returns:
- current value
-
getName
public String getName()
Return current value associated with the property corresponding toPortGrouping.getName()
.- Returns:
- current value
-
getPeerFeatures
public PortFeatures getPeerFeatures()
Return current value associated with the property corresponding toPortGrouping.getPeerFeatures()
.- Returns:
- current value
-
getPeerFeaturesV10
public PortFeaturesV10 getPeerFeaturesV10()
Return current value associated with the property corresponding toPortGrouping.getPeerFeaturesV10()
.- Returns:
- current value
-
getPortNo
public org.opendaylight.yangtools.yang.common.Uint32 getPortNo()
Return current value associated with the property corresponding toPortGrouping.getPortNo()
.- Returns:
- current value
-
getReason
public PortReason getReason()
Return current value associated with the property corresponding toPortStatus.getReason()
.- Returns:
- current value
-
getState
public PortState getState()
Return current value associated with the property corresponding toPortGrouping.getState()
.- Returns:
- current value
-
getStateV10
public PortStateV10 getStateV10()
Return current value associated with the property corresponding toPortGrouping.getStateV10()
.- Returns:
- current value
-
getSupportedFeatures
public PortFeatures getSupportedFeatures()
Return current value associated with the property corresponding toPortGrouping.getSupportedFeatures()
.- Returns:
- current value
-
getSupportedFeaturesV10
public PortFeaturesV10 getSupportedFeaturesV10()
Return current value associated with the property corresponding toPortGrouping.getSupportedFeaturesV10()
.- 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<PortStatusMessage>> 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
-
setAdvertisedFeatures
public PortStatusMessageBuilder setAdvertisedFeatures(PortFeatures value)
Set the property corresponding toPortGrouping.getAdvertisedFeatures()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAdvertisedFeaturesV10
public PortStatusMessageBuilder setAdvertisedFeaturesV10(PortFeaturesV10 value)
Set the property corresponding toPortGrouping.getAdvertisedFeaturesV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConfig
public PortStatusMessageBuilder setConfig(PortConfig value)
Set the property corresponding toPortGrouping.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConfigV10
public PortStatusMessageBuilder setConfigV10(PortConfigV10 value)
Set the property corresponding toPortGrouping.getConfigV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCurrSpeed
public PortStatusMessageBuilder setCurrSpeed(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPortGrouping.getCurrSpeed()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCurrentFeatures
public PortStatusMessageBuilder setCurrentFeatures(PortFeatures value)
Set the property corresponding toPortGrouping.getCurrentFeatures()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCurrentFeaturesV10
public PortStatusMessageBuilder setCurrentFeaturesV10(PortFeaturesV10 value)
Set the property corresponding toPortGrouping.getCurrentFeaturesV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHwAddr
public PortStatusMessageBuilder setHwAddr(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
Set the property corresponding toPortGrouping.getHwAddr()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaxSpeed
public PortStatusMessageBuilder setMaxSpeed(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPortGrouping.getMaxSpeed()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
public PortStatusMessageBuilder setName(String value)
Set the property corresponding toPortGrouping.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerFeatures
public PortStatusMessageBuilder setPeerFeatures(PortFeatures value)
Set the property corresponding toPortGrouping.getPeerFeatures()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerFeaturesV10
public PortStatusMessageBuilder setPeerFeaturesV10(PortFeaturesV10 value)
Set the property corresponding toPortGrouping.getPeerFeaturesV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPortNo
public PortStatusMessageBuilder setPortNo(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPortGrouping.getPortNo()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReason
public PortStatusMessageBuilder setReason(PortReason value)
Set the property corresponding toPortStatus.getReason()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
public PortStatusMessageBuilder setState(PortState value)
Set the property corresponding toPortGrouping.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStateV10
public PortStatusMessageBuilder setStateV10(PortStateV10 value)
Set the property corresponding toPortGrouping.getStateV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSupportedFeatures
public PortStatusMessageBuilder setSupportedFeatures(PortFeatures value)
Set the property corresponding toPortGrouping.getSupportedFeatures()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSupportedFeaturesV10
public PortStatusMessageBuilder setSupportedFeaturesV10(PortFeaturesV10 value)
Set the property corresponding toPortGrouping.getSupportedFeaturesV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
public PortStatusMessageBuilder 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 PortStatusMessageBuilder 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 PortStatusMessageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortStatusMessage> 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 PortStatusMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortStatusMessage>> 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 PortStatusMessage build()
A newPortStatusMessage
instance.- Returns:
- A new
PortStatusMessage
instance.
-
-