Class HostBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.neighbors.bgp.neighbor.peer.address.type.HostBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Host>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Host,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class HostBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Host>
Class that buildsHostBuilder
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:
HostBuilder createTarget(int fooXyzzy, int barBaz) { return new HostBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of HostBuilder, 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:
HostBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description HostBuilder()
HostBuilder(Host base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description HostBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Host>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Host> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Host>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Host
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host
getIpHostAddress()
HostBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Host>> augmentationType)
HostBuilder
setIpHostAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host value)
-
-
-
Constructor Detail
-
HostBuilder
public HostBuilder()
-
HostBuilder
public HostBuilder(Host base)
-
-
Method Detail
-
getIpHostAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host getIpHostAddress()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Host>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setIpHostAddress
public HostBuilder setIpHostAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host value)
-
addAugmentation
public HostBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Host>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Host> augmentationValue)
-
removeAugmentation
public HostBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Host>> augmentationType)
-
-