Class PortModInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortModInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PortModInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PortModInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PortModInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PortModInput>
Class that buildsPortModInput
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:
PortModInput createPortModInput(int fooXyzzy, int barBaz) { return new PortModInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PortModInput, 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:
PortModInput
,Builder
-
-
Constructor Summary
Constructors Constructor Description PortModInputBuilder()
PortModInputBuilder(OfHeader arg)
PortModInputBuilder(PortMod$G arg)
PortModInputBuilder(PortModInput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PortModInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortModInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortModInput>>
E$$augmentation(Class<E$$> augmentationType)
PortModInput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.PortFeatures
getAdvertise()
PortFeaturesV10
getAdvertiseV10()
PortConfig
getConfig()
PortConfigV10
getConfigV10()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
getHwAddress()
PortConfig
getMask()
PortConfigV10
getMaskV10()
PortNumber
getPortNo()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
PortModInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortModInput>> augmentationType)
Remove an augmentation from this builder's product.PortModInputBuilder
setAdvertise(PortFeatures value)
PortModInputBuilder
setAdvertiseV10(PortFeaturesV10 value)
PortModInputBuilder
setConfig(PortConfig value)
PortModInputBuilder
setConfigV10(PortConfigV10 value)
PortModInputBuilder
setHwAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
PortModInputBuilder
setMask(PortConfig value)
PortModInputBuilder
setMaskV10(PortConfigV10 value)
PortModInputBuilder
setPortNo(PortNumber value)
PortModInputBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
PortModInputBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
PortModInputBuilder
public PortModInputBuilder()
-
PortModInputBuilder
public PortModInputBuilder(PortMod$G arg)
-
PortModInputBuilder
public PortModInputBuilder(OfHeader arg)
-
PortModInputBuilder
public PortModInputBuilder(PortModInput 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:- PortMod$G
- OfHeader
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAdvertise
public PortFeatures getAdvertise()
-
getAdvertiseV10
public PortFeaturesV10 getAdvertiseV10()
-
getConfig
public PortConfig getConfig()
-
getConfigV10
public PortConfigV10 getConfigV10()
-
getHwAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getHwAddress()
-
getMask
public PortConfig getMask()
-
getMaskV10
public PortConfigV10 getMaskV10()
-
getPortNo
public PortNumber getPortNo()
-
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<PortModInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setAdvertise
public PortModInputBuilder setAdvertise(PortFeatures value)
-
setAdvertiseV10
public PortModInputBuilder setAdvertiseV10(PortFeaturesV10 value)
-
setConfig
public PortModInputBuilder setConfig(PortConfig value)
-
setConfigV10
public PortModInputBuilder setConfigV10(PortConfigV10 value)
-
setHwAddress
public PortModInputBuilder setHwAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
-
setMask
public PortModInputBuilder setMask(PortConfig value)
-
setMaskV10
public PortModInputBuilder setMaskV10(PortConfigV10 value)
-
setPortNo
public PortModInputBuilder setPortNo(PortNumber value)
-
setVersion
public PortModInputBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setXid
public PortModInputBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
addAugmentation
public PortModInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortModInput> 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 PortModInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortModInput>> 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 PortModInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PortModInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PortModInput,IllegalArgumentException>
-
-