Class PortBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.port.mod.port.PortBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Port>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Port,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PortBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Port>
Class that buildsPort
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:
Port createPort(int fooXyzzy, int barBaz) { return new PortBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Port, 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:
Port
,Builder
-
-
Constructor Summary
Constructors Constructor Description PortBuilder()
PortBuilder(CommonPort arg)
PortBuilder(CommonPortWithMask arg)
PortBuilder(Port base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PortBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Port> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Port>>
E$$augmentation(Class<E$$> augmentationType)
Port
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.PortFeatures
getAdvertisedFeatures()
Boolean
getBarrier()
PortConfig
getConfiguration()
String
getContainerName()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
getHardwareAddress()
PortConfig
getMask()
org.opendaylight.yangtools.yang.common.Uint32
getPortModOrder()
String
getPortName()
PortNumberUni
getPortNumber()
PortKey
key()
PortBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Port>> augmentationType)
Remove an augmentation from this builder's product.PortBuilder
setAdvertisedFeatures(PortFeatures value)
PortBuilder
setBarrier(Boolean value)
PortBuilder
setConfiguration(PortConfig value)
PortBuilder
setContainerName(String value)
PortBuilder
setHardwareAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
PortBuilder
setMask(PortConfig value)
PortBuilder
setPortModOrder(org.opendaylight.yangtools.yang.common.Uint32 value)
PortBuilder
setPortName(String value)
PortBuilder
setPortNumber(PortNumberUni value)
PortBuilder
withKey(PortKey key)
-
-
-
Constructor Detail
-
PortBuilder
public PortBuilder()
-
PortBuilder
public PortBuilder(CommonPortWithMask arg)
-
PortBuilder
public PortBuilder(CommonPort arg)
-
PortBuilder
public PortBuilder(Port 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:- CommonPortWithMask
- CommonPort
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public PortKey key()
-
getAdvertisedFeatures
public PortFeatures getAdvertisedFeatures()
-
getBarrier
public Boolean getBarrier()
-
getConfiguration
public PortConfig getConfiguration()
-
getContainerName
public String getContainerName()
-
getHardwareAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getHardwareAddress()
-
getMask
public PortConfig getMask()
-
getPortModOrder
public org.opendaylight.yangtools.yang.common.Uint32 getPortModOrder()
-
getPortName
public String getPortName()
-
getPortNumber
public PortNumberUni getPortNumber()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Port>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public PortBuilder withKey(PortKey key)
-
setAdvertisedFeatures
public PortBuilder setAdvertisedFeatures(PortFeatures value)
-
setBarrier
public PortBuilder setBarrier(Boolean value)
-
setConfiguration
public PortBuilder setConfiguration(PortConfig value)
-
setContainerName
public PortBuilder setContainerName(String value)
-
setHardwareAddress
public PortBuilder setHardwareAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
-
setMask
public PortBuilder setMask(PortConfig value)
-
setPortModOrder
public PortBuilder setPortModOrder(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setPortName
public PortBuilder setPortName(String value)
-
setPortNumber
public PortBuilder setPortNumber(PortNumberUni value)
-
addAugmentation
public PortBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Port> 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 PortBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Port>> 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 Port build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Port>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Port,IllegalArgumentException>
-
-