Class DstInfoBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.state.tunnel.list.DstInfoBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<DstInfo>
,org.opendaylight.yangtools.concepts.CheckedBuilder<DstInfo,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class DstInfoBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<DstInfo>
Class that buildsDstInfoBuilder
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:
DstInfoBuilder createTarget(int fooXyzzy, int barBaz) { return new DstInfoBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DstInfoBuilder, 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:
DstInfoBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description DstInfoBuilder()
DstInfoBuilder(TepInfoAttributes arg)
DstInfoBuilder(DstInfo base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DstInfoBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DstInfo>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DstInfo> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.DstInfoBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DstInfo> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DstInfo>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
DstInfo
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.lang.String
getTepDeviceId()
java.lang.Class<? extends TepTypeBase>
getTepDeviceType()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getTepIp()
DstInfoBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DstInfo>> augmentationType)
Remove an augmentation from this builder's product.DstInfoBuilder
setTepDeviceId(java.lang.String value)
DstInfoBuilder
setTepDeviceType(java.lang.Class<? extends TepTypeBase> value)
DstInfoBuilder
setTepIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
-
-
Constructor Detail
-
DstInfoBuilder
public DstInfoBuilder()
-
DstInfoBuilder
public DstInfoBuilder(TepInfoAttributes arg)
-
DstInfoBuilder
public DstInfoBuilder(DstInfo base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TepInfoAttributes
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getTepDeviceId
public java.lang.String getTepDeviceId()
-
getTepDeviceType
public java.lang.Class<? extends TepTypeBase> getTepDeviceType()
-
getTepIp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getTepIp()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DstInfo>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setTepDeviceId
public DstInfoBuilder setTepDeviceId(java.lang.String value)
-
setTepDeviceType
public DstInfoBuilder setTepDeviceType(java.lang.Class<? extends TepTypeBase> value)
-
setTepIp
public DstInfoBuilder setTepIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
addAugmentation
public DstInfoBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DstInfo> 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 DstInfoBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DstInfo>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DstInfo> 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 DstInfoBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DstInfo>> 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
-
-