Class UpdateKeyInputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.UpdateKeyInputBuilder
Class that builds
UpdateKeyInput
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:
UpdateKeyInput createUpdateKeyInput(int fooXyzzy, int barBaz) {
return new UpdateKeyInputBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of UpdateKeyInput, 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 opportunities, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.UpdateKeyInputBuilder
(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.EidContainer arg) Construct a new builder initialized from specifiedEidContainer
.UpdateKeyInputBuilder
(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingAuthkeyContainer arg) Construct a new builder initialized from specifiedMappingAuthkeyContainer
.Construct a builder initialized with state from specifiedUpdateKeyInput
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateKeyInput> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateKeyInput>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull UpdateKeyInput
build()
A newUpdateKeyInput
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid
getEid()
Return current value associated with the property corresponding toEidContainer.getEid()
.org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.authkey.container.MappingAuthkey
Return current value associated with the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateKeyInput>> augmentationType) Remove an augmentation from this builder's product.setEid
(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid value) Set the property corresponding toEidContainer.getEid()
to the specified value.setMappingAuthkey
(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.authkey.container.MappingAuthkey value) Set the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
to the specified value.
-
Constructor Details
-
UpdateKeyInputBuilder
public UpdateKeyInputBuilder()Construct an empty builder. -
UpdateKeyInputBuilder
public UpdateKeyInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.EidContainer arg) Construct a new builder initialized from specifiedEidContainer
.- Parameters:
arg
- EidContainer from which the builder should be initialized
-
UpdateKeyInputBuilder
public UpdateKeyInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingAuthkeyContainer arg) Construct a new builder initialized from specifiedMappingAuthkeyContainer
.- Parameters:
arg
- MappingAuthkeyContainer from which the builder should be initialized
-
UpdateKeyInputBuilder
Construct a builder initialized with state from specifiedUpdateKeyInput
.- Parameters:
base
- UpdateKeyInput from which the builder should be initialized
-
-
Method Details
-
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:EidContainer
MappingAuthkeyContainer
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getEid
public org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid getEid()Return current value associated with the property corresponding toEidContainer.getEid()
.- Returns:
- current value
-
getMappingAuthkey
public org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.authkey.container.MappingAuthkey getMappingAuthkey()Return current value associated with the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateKeyInput>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setEid
public UpdateKeyInputBuilder setEid(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid value) Set the property corresponding toEidContainer.getEid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMappingAuthkey
public UpdateKeyInputBuilder setMappingAuthkey(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.authkey.container.MappingAuthkey value) Set the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public UpdateKeyInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateKeyInput> 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 UpdateKeyInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateKeyInput>> 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
A newUpdateKeyInput
instance.- Returns:
- A new
UpdateKeyInput
instance.
-