Class AddEventDataBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.add.dpn.event.AddEventDataBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AddEventData>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AddEventData,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class AddEventDataBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<AddEventData>
Class that buildsAddEventDataBuilder
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:
AddEventDataBuilder createTarget(int fooXyzzy, int barBaz) { return new AddEventDataBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AddEventDataBuilder, 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:
AddEventDataBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AddEventDataBuilder()
AddEventDataBuilder(AddEventData base)
AddEventDataBuilder(DpnInVpnEvent arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AddEventDataBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddEventData>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AddEventData> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddEventData>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
AddEventData
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint64
getDpnId()
java.lang.String
getRd()
java.lang.String
getVpnName()
AddEventDataBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddEventData>> augmentationType)
AddEventDataBuilder
setDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDpnId(Uint64)} instead.AddEventDataBuilder
setDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
AddEventDataBuilder
setRd(java.lang.String value)
AddEventDataBuilder
setVpnName(java.lang.String value)
-
-
-
Constructor Detail
-
AddEventDataBuilder
public AddEventDataBuilder()
-
AddEventDataBuilder
public AddEventDataBuilder(DpnInVpnEvent arg)
-
AddEventDataBuilder
public AddEventDataBuilder(AddEventData 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.netvirt.l3vpn.rev130911.DpnInVpnEvent
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getDpnId
public org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
-
getRd
public java.lang.String getRd()
-
getVpnName
public java.lang.String getVpnName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddEventData>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setDpnId
public AddEventDataBuilder setDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDpnId
@Deprecated(forRemoval=true) public AddEventDataBuilder setDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDpnId(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setRd
public AddEventDataBuilder setRd(java.lang.String value)
-
setVpnName
public AddEventDataBuilder setVpnName(java.lang.String value)
-
addAugmentation
public AddEventDataBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddEventData>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AddEventData> augmentationValue)
-
removeAugmentation
public AddEventDataBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddEventData>> augmentationType)
-
build
public AddEventData build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AddEventData>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AddEventData,java.lang.IllegalArgumentException>
-
-