Class IpPortExternalBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.intext.ip.port.map.ip.port.mapping.intext.ip.protocol.type.ip.port.map.IpPortExternalBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IpPortExternal>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IpPortExternal,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class IpPortExternalBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<IpPortExternal>
Class that buildsIpPortExternalBuilder
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:
IpPortExternalBuilder createTarget(int fooXyzzy, int barBaz) { return new IpPortExternalBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpPortExternalBuilder, 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:
IpPortExternalBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IpPortExternalBuilder()
IpPortExternalBuilder(IpPortExternal base)
IpPortExternalBuilder(IpPortEntity arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IpPortExternalBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortExternal>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IpPortExternal> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortExternal>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
IpPortExternal
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.lang.String
getIpAddress()
org.opendaylight.yangtools.yang.common.Uint16
getPortNum()
IpPortExternalBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortExternal>> augmentationType)
IpPortExternalBuilder
setIpAddress(java.lang.String value)
IpPortExternalBuilder
setPortNum(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPortNum(Uint16)} instead.IpPortExternalBuilder
setPortNum(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
IpPortExternalBuilder
public IpPortExternalBuilder()
-
IpPortExternalBuilder
public IpPortExternalBuilder(IpPortEntity arg)
-
IpPortExternalBuilder
public IpPortExternalBuilder(IpPortExternal 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.netvirt.natservice.rev160111.IpPortEntity
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getIpAddress
public java.lang.String getIpAddress()
-
getPortNum
public org.opendaylight.yangtools.yang.common.Uint16 getPortNum()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortExternal>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setIpAddress
public IpPortExternalBuilder setIpAddress(java.lang.String value)
-
setPortNum
public IpPortExternalBuilder setPortNum(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setPortNum
@Deprecated(forRemoval=true) public IpPortExternalBuilder setPortNum(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPortNum(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public IpPortExternalBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortExternal>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IpPortExternal> augmentationValue)
-
removeAugmentation
public IpPortExternalBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortExternal>> augmentationType)
-
build
public IpPortExternal build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IpPortExternal>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IpPortExternal,java.lang.IllegalArgumentException>
-
-