Class ConnectionInfoBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.ConnectionInfoBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ConnectionInfo>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ConnectionInfo,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ConnectionInfoBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ConnectionInfo>
Class that buildsConnectionInfoBuilder
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:
ConnectionInfoBuilder createTarget(int fooXyzzy, int barBaz) { return new ConnectionInfoBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ConnectionInfoBuilder, 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:
ConnectionInfoBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ConnectionInfoBuilder()
ConnectionInfoBuilder(ConnectionInfo base)
ConnectionInfoBuilder(HwvtepConnectionInfoAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ConnectionInfoBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionInfo>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionInfo> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionInfo>>
E$$augmentation(Class<E$$> augmentationType)
ConnectionInfo
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getLocalIp()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getLocalPort()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getRemoteIp()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getRemotePort()
ConnectionInfoBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionInfo>> augmentationType)
ConnectionInfoBuilder
setLocalIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
ConnectionInfoBuilder
setLocalPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
ConnectionInfoBuilder
setRemoteIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
ConnectionInfoBuilder
setRemotePort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
-
-
Constructor Detail
-
ConnectionInfoBuilder
public ConnectionInfoBuilder()
-
ConnectionInfoBuilder
public ConnectionInfoBuilder(HwvtepConnectionInfoAttributes arg)
-
ConnectionInfoBuilder
public ConnectionInfoBuilder(ConnectionInfo 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.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepConnectionInfoAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getLocalIp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getLocalIp()
-
getLocalPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getLocalPort()
-
getRemoteIp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getRemoteIp()
-
getRemotePort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getRemotePort()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionInfo>> E$$ augmentation(Class<E$$> augmentationType)
-
setLocalIp
public ConnectionInfoBuilder setLocalIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setLocalPort
public ConnectionInfoBuilder setLocalPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
setRemoteIp
public ConnectionInfoBuilder setRemoteIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setRemotePort
public ConnectionInfoBuilder setRemotePort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
addAugmentation
public ConnectionInfoBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionInfo>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionInfo> augmentationValue)
-
removeAugmentation
public ConnectionInfoBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConnectionInfo>> augmentationType)
-
build
public ConnectionInfo build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ConnectionInfo>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ConnectionInfo,IllegalArgumentException>
-
-