Class DcGatewayIpBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.dc.gateway.ip.list.DcGatewayIpBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<DcGatewayIp>
,org.opendaylight.yangtools.concepts.CheckedBuilder<DcGatewayIp,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class DcGatewayIpBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<DcGatewayIp>
Class that buildsDcGatewayIpBuilder
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:
DcGatewayIpBuilder createTarget(int fooXyzzy, int barBaz) { return new DcGatewayIpBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DcGatewayIpBuilder, 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:
DcGatewayIpBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description DcGatewayIpBuilder()
DcGatewayIpBuilder(DcGatewayIp base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DcGatewayIpBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DcGatewayIp> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DcGatewayIp>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
DcGatewayIp
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getIpAddress()
java.lang.Class<? extends TunnelTypeBase>
getTunnnelType()
DcGatewayIpKey
key()
DcGatewayIpBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DcGatewayIp>> augmentationType)
Remove an augmentation from this builder's product.DcGatewayIpBuilder
setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
DcGatewayIpBuilder
setTunnnelType(java.lang.Class<? extends TunnelTypeBase> value)
DcGatewayIpBuilder
withKey(DcGatewayIpKey key)
-
-
-
Constructor Detail
-
DcGatewayIpBuilder
public DcGatewayIpBuilder()
-
DcGatewayIpBuilder
public DcGatewayIpBuilder(DcGatewayIp base)
-
-
Method Detail
-
key
public DcGatewayIpKey key()
-
getIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpAddress()
-
getTunnnelType
public java.lang.Class<? extends TunnelTypeBase> getTunnnelType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DcGatewayIp>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public DcGatewayIpBuilder withKey(DcGatewayIpKey key)
-
setIpAddress
public DcGatewayIpBuilder setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setTunnnelType
public DcGatewayIpBuilder setTunnnelType(java.lang.Class<? extends TunnelTypeBase> value)
-
addAugmentation
public DcGatewayIpBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DcGatewayIp> 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
-
removeAugmentation
public DcGatewayIpBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DcGatewayIp>> 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 DcGatewayIp build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<DcGatewayIp>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<DcGatewayIp,java.lang.IllegalArgumentException>
-
-