Class FlowCapableNodeConnectorBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnectorBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlowCapableNodeConnector>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlowCapableNodeConnector,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlowCapableNodeConnectorBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowCapableNodeConnector>
Class that buildsFlowCapableNodeConnectorBuilder
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:
FlowCapableNodeConnectorBuilder createTarget(int fooXyzzy, int barBaz) { return new FlowCapableNodeConnectorBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowCapableNodeConnectorBuilder, 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:
FlowCapableNodeConnectorBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowCapableNodeConnectorBuilder()
FlowCapableNodeConnectorBuilder(FlowCapableNodeConnector base)
FlowCapableNodeConnectorBuilder(FlowNodeConnector arg)
FlowCapableNodeConnectorBuilder(CommonPort arg)
FlowCapableNodeConnectorBuilder(FlowCapablePort arg)
FlowCapableNodeConnectorBuilder(Queues arg)
-
Method Summary
-
-
-
Constructor Detail
-
FlowCapableNodeConnectorBuilder
public FlowCapableNodeConnectorBuilder()
-
FlowCapableNodeConnectorBuilder
public FlowCapableNodeConnectorBuilder(FlowNodeConnector arg)
-
FlowCapableNodeConnectorBuilder
public FlowCapableNodeConnectorBuilder(FlowCapablePort arg)
-
FlowCapableNodeConnectorBuilder
public FlowCapableNodeConnectorBuilder(CommonPort arg)
-
FlowCapableNodeConnectorBuilder
public FlowCapableNodeConnectorBuilder(Queues arg)
-
FlowCapableNodeConnectorBuilder
public FlowCapableNodeConnectorBuilder(FlowCapableNodeConnector 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.flow.inventory.rev130819.FlowNodeConnector
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.Queues
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.FlowCapablePort
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.CommonPort
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAdvertisedFeatures
public PortFeatures getAdvertisedFeatures()
-
getConfiguration
public PortConfig getConfiguration()
-
getCurrentFeature
public PortFeatures getCurrentFeature()
-
getCurrentSpeed
public org.opendaylight.yangtools.yang.common.Uint32 getCurrentSpeed()
-
getHardwareAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getHardwareAddress()
-
getMaximumSpeed
public org.opendaylight.yangtools.yang.common.Uint32 getMaximumSpeed()
-
getName
public String getName()
-
getPeerFeatures
public PortFeatures getPeerFeatures()
-
getPortNumber
public PortNumberUni getPortNumber()
-
getReason
public PortReason getReason()
-
getState
public State getState()
-
getSupported
public PortFeatures getSupported()
-
setAdvertisedFeatures
public FlowCapableNodeConnectorBuilder setAdvertisedFeatures(PortFeatures value)
-
setConfiguration
public FlowCapableNodeConnectorBuilder setConfiguration(PortConfig value)
-
setCurrentFeature
public FlowCapableNodeConnectorBuilder setCurrentFeature(PortFeatures value)
-
setCurrentSpeed
public FlowCapableNodeConnectorBuilder setCurrentSpeed(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setCurrentSpeed
@Deprecated(forRemoval=true) public FlowCapableNodeConnectorBuilder setCurrentSpeed(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetCurrentSpeed(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setHardwareAddress
public FlowCapableNodeConnectorBuilder setHardwareAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
-
setMaximumSpeed
public FlowCapableNodeConnectorBuilder setMaximumSpeed(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMaximumSpeed
@Deprecated(forRemoval=true) public FlowCapableNodeConnectorBuilder setMaximumSpeed(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMaximumSpeed(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setName
public FlowCapableNodeConnectorBuilder setName(String value)
-
setPeerFeatures
public FlowCapableNodeConnectorBuilder setPeerFeatures(PortFeatures value)
-
setPortNumber
public FlowCapableNodeConnectorBuilder setPortNumber(PortNumberUni value)
-
setQueue
public FlowCapableNodeConnectorBuilder setQueue(Map<QueueKey,Queue> values)
-
setQueue
@Deprecated(forRemoval=true) public FlowCapableNodeConnectorBuilder setQueue(List<Queue> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetQueue(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
setReason
public FlowCapableNodeConnectorBuilder setReason(PortReason value)
-
setState
public FlowCapableNodeConnectorBuilder setState(State value)
-
setSupported
public FlowCapableNodeConnectorBuilder setSupported(PortFeatures value)
-
build
public FlowCapableNodeConnector build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowCapableNodeConnector>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowCapableNodeConnector,IllegalArgumentException>
-
-