Class HostNameBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.rpki.config.cache.server.config.server.HostNameBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<HostName>
,org.opendaylight.yangtools.concepts.CheckedBuilder<HostName,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class HostNameBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<HostName>
Class that buildsHostNameBuilder
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:
HostNameBuilder createTarget(int fooXyzzy, int barBaz) { return new HostNameBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of HostNameBuilder, 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:
HostNameBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description HostNameBuilder()
HostNameBuilder(HostName base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description HostNameBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<HostName>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<HostName> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.HostNameBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<HostName> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<HostName>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
HostName
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host
getIpHostAddress()
HostNameBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<HostName>> augmentationType)
Remove an augmentation from this builder's product.HostNameBuilder
setIpHostAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host value)
-
-
-
Constructor Detail
-
HostNameBuilder
public HostNameBuilder()
-
HostNameBuilder
public HostNameBuilder(HostName 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<HostName>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setIpHostAddress
public HostNameBuilder setIpHostAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host value)
-
addAugmentation
public HostNameBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<HostName> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public HostNameBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<HostName>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<HostName> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public HostNameBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<HostName>> 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
-
-