Class DcGatewayBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.l3vpn.dc.gws.DcGatewayBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<DcGateway>
,org.opendaylight.yangtools.concepts.CheckedBuilder<DcGateway,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class DcGatewayBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<DcGateway>
Class that buildsDcGatewayBuilder
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:
DcGatewayBuilder createTarget(int fooXyzzy, int barBaz) { return new DcGatewayBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DcGatewayBuilder, 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:
DcGatewayBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description DcGatewayBuilder()
DcGatewayBuilder(DcGateway base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DcGatewayBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DcGateway> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DcGateway>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
DcGateway
build()
java.lang.String
getIpAddress()
DcGatewayKey
key()
DcGatewayBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DcGateway>> augmentationType)
Remove an augmentation from this builder's product.DcGatewayBuilder
setIpAddress(java.lang.String value)
DcGatewayBuilder
withKey(DcGatewayKey key)
-
-
-
Constructor Detail
-
DcGatewayBuilder
public DcGatewayBuilder()
-
DcGatewayBuilder
public DcGatewayBuilder(DcGateway base)
-
-
Method Detail
-
key
public DcGatewayKey key()
-
getIpAddress
public java.lang.String getIpAddress()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DcGateway>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public DcGatewayBuilder withKey(DcGatewayKey key)
-
setIpAddress
public DcGatewayBuilder setIpAddress(java.lang.String value)
-
addAugmentation
public DcGatewayBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DcGateway> 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 DcGatewayBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DcGateway>> 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
-
-