Class PortMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortMessageBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PortMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PortMessage,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PortMessageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PortMessage>
Class that buildsPortMessage
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:
PortMessage createPortMessage(int fooXyzzy, int barBaz) { return new PortMessageBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PortMessage, 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:
PortMessage
,Builder
-
-
Constructor Summary
Constructors Constructor Description PortMessageBuilder()
PortMessageBuilder(CommonPort arg)
PortMessageBuilder(CommonPortWithMask arg)
PortMessageBuilder(PortMessage base)
PortMessageBuilder(OfHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PortMessageBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortMessage> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortMessage>>
E$$augmentation(Class<E$$> augmentationType)
PortMessage
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.PortFeatures
getAdvertisedFeatures()
PortConfig
getConfiguration()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
getHardwareAddress()
PortConfig
getMask()
PortNumberUni
getPortNumber()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
PortMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortMessage>> augmentationType)
Remove an augmentation from this builder's product.PortMessageBuilder
setAdvertisedFeatures(PortFeatures value)
PortMessageBuilder
setConfiguration(PortConfig value)
PortMessageBuilder
setHardwareAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
PortMessageBuilder
setMask(PortConfig value)
PortMessageBuilder
setPortNumber(PortNumberUni value)
PortMessageBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
PortMessageBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
PortMessageBuilder
public PortMessageBuilder()
-
PortMessageBuilder
public PortMessageBuilder(CommonPortWithMask arg)
-
PortMessageBuilder
public PortMessageBuilder(CommonPort arg)
-
PortMessageBuilder
public PortMessageBuilder(OfHeader arg)
-
PortMessageBuilder
public PortMessageBuilder(PortMessage 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
- OfHeader
- 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()
-
getHardwareAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getHardwareAddress()
-
getMask
public PortConfig getMask()
-
getPortNumber
public PortNumberUni getPortNumber()
-
getVersion
public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
-
getXid
public org.opendaylight.yangtools.yang.common.Uint32 getXid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortMessage>> E$$ augmentation(Class<E$$> augmentationType)
-
setAdvertisedFeatures
public PortMessageBuilder setAdvertisedFeatures(PortFeatures value)
-
setConfiguration
public PortMessageBuilder setConfiguration(PortConfig value)
-
setHardwareAddress
public PortMessageBuilder setHardwareAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
-
setMask
public PortMessageBuilder setMask(PortConfig value)
-
setPortNumber
public PortMessageBuilder setPortNumber(PortNumberUni value)
-
setVersion
public PortMessageBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setXid
public PortMessageBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
addAugmentation
public PortMessageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortMessage> 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 PortMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortMessage>> 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 PortMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PortMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PortMessage,IllegalArgumentException>
-
-