Class PortModInputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortModInputBuilder
Class that builds
PortModInput
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedOfHeader
.Construct a new builder initialized from specifiedPortMod$G
.Construct a builder initialized with state from specifiedPortModInput
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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) Return the specified augmentation, if it is present in this builder.@NonNull PortModInput
build()
A newPortModInput
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toPortMod$G.getAdvertise()
.Return current value associated with the property corresponding toPortMod$G.getAdvertiseV10()
.Return current value associated with the property corresponding toPortMod$G.getConfig()
.Return current value associated with the property corresponding toPortMod$G.getConfigV10()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
Return current value associated with the property corresponding toPortMod$G.getHwAddress()
.getMask()
Return current value associated with the property corresponding toPortMod$G.getMask()
.Return current value associated with the property corresponding toPortMod$G.getMaskV10()
.Return current value associated with the property corresponding toPortMod$G.getPortNo()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toOfHeader.getVersion()
.org.opendaylight.yangtools.yang.common.Uint32
getXid()
Return current value associated with the property corresponding toOfHeader.getXid()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortModInput>> augmentationType) Remove an augmentation from this builder's product.setAdvertise
(PortFeatures value) Set the property corresponding toPortMod$G.getAdvertise()
to the specified value.setAdvertiseV10
(PortFeaturesV10 value) Set the property corresponding toPortMod$G.getAdvertiseV10()
to the specified value.setConfig
(PortConfig value) Set the property corresponding toPortMod$G.getConfig()
to the specified value.setConfigV10
(PortConfigV10 value) Set the property corresponding toPortMod$G.getConfigV10()
to the specified value.setHwAddress
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value) Set the property corresponding toPortMod$G.getHwAddress()
to the specified value.setMask
(PortConfig value) Set the property corresponding toPortMod$G.getMask()
to the specified value.setMaskV10
(PortConfigV10 value) Set the property corresponding toPortMod$G.getMaskV10()
to the specified value.setPortNo
(PortNumber value) Set the property corresponding toPortMod$G.getPortNo()
to the specified value.setVersion
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toOfHeader.getVersion()
to the specified value.setXid
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toOfHeader.getXid()
to the specified value.
-
Constructor Details
-
PortModInputBuilder
public PortModInputBuilder()Construct an empty builder. -
PortModInputBuilder
Construct a new builder initialized from specifiedPortMod$G
.- Parameters:
arg
- PortMod$G from which the builder should be initialized
-
PortModInputBuilder
Construct a new builder initialized from specifiedOfHeader
.- Parameters:
arg
- OfHeader from which the builder should be initialized
-
PortModInputBuilder
Construct a builder initialized with state from specifiedPortModInput
.- Parameters:
base
- PortModInput from which the builder should be initialized
-
-
Method Details
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAdvertise
Return current value associated with the property corresponding toPortMod$G.getAdvertise()
.- Returns:
- current value
-
getAdvertiseV10
Return current value associated with the property corresponding toPortMod$G.getAdvertiseV10()
.- Returns:
- current value
-
getConfig
Return current value associated with the property corresponding toPortMod$G.getConfig()
.- Returns:
- current value
-
getConfigV10
Return current value associated with the property corresponding toPortMod$G.getConfigV10()
.- Returns:
- current value
-
getHwAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getHwAddress()Return current value associated with the property corresponding toPortMod$G.getHwAddress()
.- Returns:
- current value
-
getMask
Return current value associated with the property corresponding toPortMod$G.getMask()
.- Returns:
- current value
-
getMaskV10
Return current value associated with the property corresponding toPortMod$G.getMaskV10()
.- Returns:
- current value
-
getPortNo
Return current value associated with the property corresponding toPortMod$G.getPortNo()
.- Returns:
- current value
-
getVersion
public org.opendaylight.yangtools.yang.common.Uint8 getVersion()Return current value associated with the property corresponding toOfHeader.getVersion()
.- Returns:
- current value
-
getXid
public org.opendaylight.yangtools.yang.common.Uint32 getXid()Return current value associated with the property corresponding toOfHeader.getXid()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortModInput>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setAdvertise
Set the property corresponding toPortMod$G.getAdvertise()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAdvertiseV10
Set the property corresponding toPortMod$G.getAdvertiseV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConfig
Set the property corresponding toPortMod$G.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConfigV10
Set the property corresponding toPortMod$G.getConfigV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHwAddress
public PortModInputBuilder setHwAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value) Set the property corresponding toPortMod$G.getHwAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMask
Set the property corresponding toPortMod$G.getMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaskV10
Set the property corresponding toPortMod$G.getMaskV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPortNo
Set the property corresponding toPortMod$G.getPortNo()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
Set the property corresponding toOfHeader.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXid
Set the property corresponding toOfHeader.getXid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
A newPortModInput
instance.- Returns:
- A new
PortModInput
instance.
-