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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MappingAuthkey>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MappingAuthkey,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MappingAuthkeyBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<MappingAuthkey>
Class that buildsMappingAuthkeyBuilder
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:
MappingAuthkeyBuilder createTarget(int fooXyzzy, int barBaz) { return new MappingAuthkeyBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MappingAuthkeyBuilder, 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:
MappingAuthkeyBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MappingAuthkeyBuilder()
MappingAuthkeyBuilder(MappingAuthkey base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MappingAuthkeyBuilder
addAugmentation(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(java.lang.Class<E$$> augmentationType)
MappingAuthkey
build()
java.lang.String
getKeyString()
org.opendaylight.yangtools.yang.common.Uint16
getKeyType()
MappingAuthkeyBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkey>> augmentationType)
Remove an augmentation from this builder's product.MappingAuthkeyBuilder
setKeyString(java.lang.String value)
MappingAuthkeyBuilder
setKeyType(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetKeyType(Uint16)
instead.MappingAuthkeyBuilder
setKeyType(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
MappingAuthkeyBuilder
public MappingAuthkeyBuilder()
-
MappingAuthkeyBuilder
public MappingAuthkeyBuilder(MappingAuthkey base)
-
-
Method Detail
-
getKeyString
public java.lang.String getKeyString()
-
getKeyType
public org.opendaylight.yangtools.yang.common.Uint16 getKeyType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkey>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setKeyString
public MappingAuthkeyBuilder setKeyString(java.lang.String value)
-
setKeyType
public MappingAuthkeyBuilder setKeyType(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setKeyType
@Deprecated(forRemoval=true) public MappingAuthkeyBuilder setKeyType(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetKeyType(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- 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:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public MappingAuthkeyBuilder removeAugmentation(java.lang.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
public MappingAuthkey build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MappingAuthkey>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MappingAuthkey,java.lang.IllegalArgumentException>
-
-