Class PhyPortBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.features.reply.PhyPortBuilder
Class that builds
PhyPort
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:
PhyPort createPhyPort(int fooXyzzy, int barBaz) {
return new PhyPortBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of PhyPort, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.PhyPortBuilder
(PhyPort base) Construct a builder initialized with state from specifiedPhyPort
.Construct a new builder initialized from specifiedPortGrouping
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<PhyPort> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PhyPort>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull PhyPort
build()
A newPhyPort
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toPortGrouping.getAdvertisedFeatures()
.Return current value associated with the property corresponding toPortGrouping.getAdvertisedFeaturesV10()
.Return current value associated with the property corresponding toPortGrouping.getConfig()
.Return current value associated with the property corresponding toPortGrouping.getConfigV10()
.Return current value associated with the property corresponding toPortGrouping.getCurrentFeatures()
.Return current value associated with the property corresponding toPortGrouping.getCurrentFeaturesV10()
.org.opendaylight.yangtools.yang.common.Uint32
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
Return current value associated with the property corresponding toPortGrouping.getHwAddr()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toPortGrouping.getMaxSpeed()
.getName()
Return current value associated with the property corresponding toPortGrouping.getName()
.Return current value associated with the property corresponding toPortGrouping.getPeerFeatures()
.Return current value associated with the property corresponding toPortGrouping.getPeerFeaturesV10()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toPortGrouping.getPortNo()
.getState()
Return current value associated with the property corresponding toPortGrouping.getState()
.Return current value associated with the property corresponding toPortGrouping.getStateV10()
.Return current value associated with the property corresponding toPortGrouping.getSupportedFeatures()
.Return current value associated with the property corresponding toPortGrouping.getSupportedFeaturesV10()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PhyPort>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toPortGrouping.getAdvertisedFeatures()
to the specified value.Set the property corresponding toPortGrouping.getAdvertisedFeaturesV10()
to the specified value.setConfig
(PortConfig value) Set the property corresponding toPortGrouping.getConfig()
to the specified value.setConfigV10
(PortConfigV10 value) Set the property corresponding toPortGrouping.getConfigV10()
to the specified value.setCurrentFeatures
(PortFeatures value) Set the property corresponding toPortGrouping.getCurrentFeatures()
to the specified value.Set the property corresponding toPortGrouping.getCurrentFeaturesV10()
to the specified value.setCurrSpeed
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toPortGrouping.getCurrSpeed()
to the specified value.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.setMaxSpeed
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toPortGrouping.getMaxSpeed()
to the specified value.Set the property corresponding toPortGrouping.getName()
to the specified value.setPeerFeatures
(PortFeatures value) Set the property corresponding toPortGrouping.getPeerFeatures()
to the specified value.Set the property corresponding toPortGrouping.getPeerFeaturesV10()
to the specified value.setPortNo
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toPortGrouping.getPortNo()
to the specified value.Set the property corresponding toPortGrouping.getState()
to the specified value.setStateV10
(PortStateV10 value) Set the property corresponding toPortGrouping.getStateV10()
to the specified value.setSupportedFeatures
(PortFeatures value) Set the property corresponding toPortGrouping.getSupportedFeatures()
to the specified value.Set the property corresponding toPortGrouping.getSupportedFeaturesV10()
to the specified value.
-
Constructor Details
-
PhyPortBuilder
public PhyPortBuilder()Construct an empty builder. -
PhyPortBuilder
Construct a new builder initialized from specifiedPortGrouping
.- Parameters:
arg
- PortGrouping from which the builder should be initialized
-
PhyPortBuilder
Construct a builder initialized with state from specifiedPhyPort
.- Parameters:
base
- PhyPort from which the builder should be initialized
-
-
Method Details
-
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
Return current value associated with the property corresponding toPortGrouping.getAdvertisedFeatures()
.- Returns:
- current value
-
getAdvertisedFeaturesV10
Return current value associated with the property corresponding toPortGrouping.getAdvertisedFeaturesV10()
.- Returns:
- current value
-
getConfig
Return current value associated with the property corresponding toPortGrouping.getConfig()
.- Returns:
- current value
-
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
Return current value associated with the property corresponding toPortGrouping.getCurrentFeatures()
.- Returns:
- current value
-
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
Return current value associated with the property corresponding toPortGrouping.getName()
.- Returns:
- current value
-
getPeerFeatures
Return current value associated with the property corresponding toPortGrouping.getPeerFeatures()
.- Returns:
- current value
-
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
-
getState
Return current value associated with the property corresponding toPortGrouping.getState()
.- Returns:
- current value
-
getStateV10
Return current value associated with the property corresponding toPortGrouping.getStateV10()
.- Returns:
- current value
-
getSupportedFeatures
Return current value associated with the property corresponding toPortGrouping.getSupportedFeatures()
.- Returns:
- current value
-
getSupportedFeaturesV10
Return current value associated with the property corresponding toPortGrouping.getSupportedFeaturesV10()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PhyPort>> 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
Set the property corresponding toPortGrouping.getAdvertisedFeatures()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAdvertisedFeaturesV10
Set the property corresponding toPortGrouping.getAdvertisedFeaturesV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConfig
Set the property corresponding toPortGrouping.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConfigV10
Set the property corresponding toPortGrouping.getConfigV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCurrSpeed
Set the property corresponding toPortGrouping.getCurrSpeed()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCurrentFeatures
Set the property corresponding toPortGrouping.getCurrentFeatures()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCurrentFeaturesV10
Set the property corresponding toPortGrouping.getCurrentFeaturesV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHwAddr
public PhyPortBuilder 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
Set the property corresponding toPortGrouping.getMaxSpeed()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
Set the property corresponding toPortGrouping.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerFeatures
Set the property corresponding toPortGrouping.getPeerFeatures()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerFeaturesV10
Set the property corresponding toPortGrouping.getPeerFeaturesV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPortNo
Set the property corresponding toPortGrouping.getPortNo()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
Set the property corresponding toPortGrouping.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStateV10
Set the property corresponding toPortGrouping.getStateV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSupportedFeatures
Set the property corresponding toPortGrouping.getSupportedFeatures()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSupportedFeaturesV10
Set the property corresponding toPortGrouping.getSupportedFeaturesV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PhyPortBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PhyPort> 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 PhyPortBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PhyPort>> 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
A newPhyPort
instance.- Returns:
- A new
PhyPort
instance.
-