Class HostRoutesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnet.attributes.HostRoutesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<HostRoutes>
,org.opendaylight.yangtools.concepts.CheckedBuilder<HostRoutes,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class HostRoutesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<HostRoutes>
Class that buildsHostRoutesBuilder
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:
HostRoutesBuilder createTarget(int fooXyzzy, int barBaz) { return new HostRoutesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of HostRoutesBuilder, 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:
HostRoutesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description HostRoutesBuilder()
HostRoutesBuilder(HostRoutes base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description HostRoutesBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<HostRoutes>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<HostRoutes> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.HostRoutesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<HostRoutes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<HostRoutes>>
E$$augmentation(Class<E$$> augmentationType)
HostRoutes
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getDestination()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getNexthop()
HostRoutesKey
key()
HostRoutesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<HostRoutes>> augmentationType)
Remove an augmentation from this builder's product.HostRoutesBuilder
setDestination(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
HostRoutesBuilder
setNexthop(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
HostRoutesBuilder
withKey(HostRoutesKey key)
-
-
-
Constructor Detail
-
HostRoutesBuilder
public HostRoutesBuilder()
-
HostRoutesBuilder
public HostRoutesBuilder(HostRoutes base)
-
-
Method Detail
-
key
public HostRoutesKey key()
-
getDestination
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getDestination()
-
getNexthop
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getNexthop()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<HostRoutes>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public HostRoutesBuilder withKey(HostRoutesKey key)
-
setDestination
public HostRoutesBuilder setDestination(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
setNexthop
public HostRoutesBuilder setNexthop(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
addAugmentation
public HostRoutesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<HostRoutes> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public HostRoutesBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<HostRoutes>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<HostRoutes> 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 HostRoutesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<HostRoutes>> 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
public HostRoutes build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<HostRoutes>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<HostRoutes,IllegalArgumentException>
-
-