Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.vpnaas.rev150712.ipsecconnection.attributes
Class DpdBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.vpnaas.rev150712.ipsecconnection.attributes.DpdBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Dpd>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Dpd,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class DpdBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Dpd>
Class that buildsDpdBuilder
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:
DpdBuilder createTarget(int fooXyzzy, int barBaz) { return new DpdBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DpdBuilder, 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:
DpdBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description DpdBuilder()
DpdBuilder(Dpd base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DpdBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Dpd> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Dpd>>
E$$augmentation(Class<E$$> augmentationType)
Dpd
build()
String
getAction()
Integer
getInterval()
Integer
getTimeout()
DpdBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Dpd>> augmentationType)
Remove an augmentation from this builder's product.DpdBuilder
setAction(String value)
DpdBuilder
setInterval(Integer value)
DpdBuilder
setTimeout(Integer value)
-
-
-
Constructor Detail
-
DpdBuilder
public DpdBuilder()
-
DpdBuilder
public DpdBuilder(Dpd base)
-
-
Method Detail
-
getAction
public String getAction()
-
getInterval
public Integer getInterval()
-
getTimeout
public Integer getTimeout()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Dpd>> E$$ augmentation(Class<E$$> augmentationType)
-
setAction
public DpdBuilder setAction(String value)
-
setInterval
public DpdBuilder setInterval(Integer value)
-
setTimeout
public DpdBuilder setTimeout(Integer value)
-
addAugmentation
public DpdBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Dpd> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public DpdBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Dpd>> 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 Dpd build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Dpd>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Dpd,IllegalArgumentException>
-
-