Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.authkey.container
Class MappingAuthkeyBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.authkey.container.MappingAuthkeyBuilder
Class that builds
MappingAuthkey
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:
MappingAuthkey createMappingAuthkey(int fooXyzzy, int barBaz) {
return new MappingAuthkeyBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of MappingAuthkey, 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.Construct a builder initialized with state from specifiedMappingAuthkey
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkey> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkey>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull MappingAuthkey
build()
A newMappingAuthkey
instance.Return current value associated with the property corresponding toMappingAuthkey.getKeyString()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toMappingAuthkey.getKeyType()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkey>> augmentationType) Remove an augmentation from this builder's product.setKeyString
(String value) Set the property corresponding toMappingAuthkey.getKeyString()
to the specified value.setKeyType
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toMappingAuthkey.getKeyType()
to the specified value.
-
Constructor Details
-
MappingAuthkeyBuilder
public MappingAuthkeyBuilder()Construct an empty builder. -
MappingAuthkeyBuilder
Construct a builder initialized with state from specifiedMappingAuthkey
.- Parameters:
base
- MappingAuthkey from which the builder should be initialized
-
-
Method Details
-
getKeyString
Return current value associated with the property corresponding toMappingAuthkey.getKeyString()
.- Returns:
- current value
-
getKeyType
public org.opendaylight.yangtools.yang.common.Uint16 getKeyType()Return current value associated with the property corresponding toMappingAuthkey.getKeyType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkey>> 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
-
setKeyString
Set the property corresponding toMappingAuthkey.getKeyString()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setKeyType
Set the property corresponding toMappingAuthkey.getKeyType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MappingAuthkeyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkey> 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 MappingAuthkeyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkey>> 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 newMappingAuthkey
instance.- Returns:
- A new
MappingAuthkey
instance.
-