Class PortsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.multipart.reply.multipart.reply.body.multipart.reply.port.desc.PortsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ports>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ports,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PortsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ports>
Class that buildsPortsBuilder
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:
PortsBuilder createTarget(int fooXyzzy, int barBaz) { return new PortsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PortsBuilder, 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:
PortsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PortsBuilder()
PortsBuilder(CommonPort arg)
PortsBuilder(FlowCapablePort arg)
PortsBuilder(Ports base)
PortsBuilder(Queues arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PortsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ports> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ports>>
E$$augmentation(Class<E$$> augmentationType)
Ports
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.PortFeatures
getAdvertisedFeatures()
PortConfig
getConfiguration()
PortFeatures
getCurrentFeature()
org.opendaylight.yangtools.yang.common.Uint32
getCurrentSpeed()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
getHardwareAddress()
org.opendaylight.yangtools.yang.common.Uint32
getMaximumSpeed()
String
getName()
PortFeatures
getPeerFeatures()
PortNumberUni
getPortNumber()
Map<QueueKey,Queue>
getQueue()
State
getState()
PortFeatures
getSupported()
PortsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ports>> augmentationType)
Remove an augmentation from this builder's product.PortsBuilder
setAdvertisedFeatures(PortFeatures value)
PortsBuilder
setConfiguration(PortConfig value)
PortsBuilder
setCurrentFeature(PortFeatures value)
PortsBuilder
setCurrentSpeed(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetCurrentSpeed(Uint32)
instead.PortsBuilder
setCurrentSpeed(org.opendaylight.yangtools.yang.common.Uint32 value)
PortsBuilder
setHardwareAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
PortsBuilder
setMaximumSpeed(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMaximumSpeed(Uint32)
instead.PortsBuilder
setMaximumSpeed(org.opendaylight.yangtools.yang.common.Uint32 value)
PortsBuilder
setName(String value)
PortsBuilder
setPeerFeatures(PortFeatures value)
PortsBuilder
setPortNumber(PortNumberUni value)
PortsBuilder
setQueue(List<Queue> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetQueue(Map)
instead.PortsBuilder
setQueue(Map<QueueKey,Queue> values)
PortsBuilder
setState(State value)
PortsBuilder
setSupported(PortFeatures value)
-
-
-
Constructor Detail
-
PortsBuilder
public PortsBuilder()
-
PortsBuilder
public PortsBuilder(FlowCapablePort arg)
-
PortsBuilder
public PortsBuilder(CommonPort arg)
-
PortsBuilder
public PortsBuilder(Queues arg)
-
PortsBuilder
public PortsBuilder(Ports 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.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()
-
getState
public State getState()
-
getSupported
public PortFeatures getSupported()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ports>> E$$ augmentation(Class<E$$> augmentationType)
-
setAdvertisedFeatures
public PortsBuilder setAdvertisedFeatures(PortFeatures value)
-
setConfiguration
public PortsBuilder setConfiguration(PortConfig value)
-
setCurrentFeature
public PortsBuilder setCurrentFeature(PortFeatures value)
-
setCurrentSpeed
public PortsBuilder setCurrentSpeed(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setCurrentSpeed
@Deprecated(forRemoval=true) public PortsBuilder 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 PortsBuilder setHardwareAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
-
setMaximumSpeed
public PortsBuilder setMaximumSpeed(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMaximumSpeed
@Deprecated(forRemoval=true) public PortsBuilder 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 PortsBuilder setName(String value)
-
setPeerFeatures
public PortsBuilder setPeerFeatures(PortFeatures value)
-
setPortNumber
public PortsBuilder setPortNumber(PortNumberUni value)
-
setQueue
public PortsBuilder setQueue(Map<QueueKey,Queue> values)
-
setQueue
@Deprecated(forRemoval=true) public PortsBuilder 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
-
setState
public PortsBuilder setState(State value)
-
setSupported
public PortsBuilder setSupported(PortFeatures value)
-
addAugmentation
public PortsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ports> 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 PortsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ports>> 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 Ports build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ports>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ports,IllegalArgumentException>
-
-