Class EidAuthkeyItemBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.eid.authkey.list.EidAuthkeyItemBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<EidAuthkeyItem>
,org.opendaylight.yangtools.concepts.CheckedBuilder<EidAuthkeyItem,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class EidAuthkeyItemBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<EidAuthkeyItem>
Class that buildsEidAuthkeyItemBuilder
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:
EidAuthkeyItemBuilder createTarget(int fooXyzzy, int barBaz) { return new EidAuthkeyItemBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EidAuthkeyItemBuilder, 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:
EidAuthkeyItemBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description EidAuthkeyItemBuilder()
EidAuthkeyItemBuilder(EidContainer arg)
EidAuthkeyItemBuilder(MappingAuthkeyContainer arg)
EidAuthkeyItemBuilder(EidAuthkeyItem base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description EidAuthkeyItemBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EidAuthkeyItem>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<EidAuthkeyItem> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.EidAuthkeyItemBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EidAuthkeyItem> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EidAuthkeyItem>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
EidAuthkeyItem
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Eid
getEid()
java.lang.String
getEidAuthkeyItemId()
MappingAuthkey
getMappingAuthkey()
EidAuthkeyItemKey
key()
EidAuthkeyItemBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EidAuthkeyItem>> augmentationType)
Remove an augmentation from this builder's product.EidAuthkeyItemBuilder
setEid(Eid value)
EidAuthkeyItemBuilder
setEidAuthkeyItemId(java.lang.String value)
EidAuthkeyItemBuilder
setMappingAuthkey(MappingAuthkey value)
EidAuthkeyItemBuilder
withKey(EidAuthkeyItemKey key)
-
-
-
Constructor Detail
-
EidAuthkeyItemBuilder
public EidAuthkeyItemBuilder()
-
EidAuthkeyItemBuilder
public EidAuthkeyItemBuilder(EidContainer arg)
-
EidAuthkeyItemBuilder
public EidAuthkeyItemBuilder(MappingAuthkeyContainer arg)
-
EidAuthkeyItemBuilder
public EidAuthkeyItemBuilder(EidAuthkeyItem 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.lfm.lisp.proto.rev151105.EidContainer
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingAuthkeyContainer
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
key
public EidAuthkeyItemKey key()
-
getEid
public Eid getEid()
-
getEidAuthkeyItemId
public java.lang.String getEidAuthkeyItemId()
-
getMappingAuthkey
public MappingAuthkey getMappingAuthkey()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EidAuthkeyItem>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public EidAuthkeyItemBuilder withKey(EidAuthkeyItemKey key)
-
setEid
public EidAuthkeyItemBuilder setEid(Eid value)
-
setEidAuthkeyItemId
public EidAuthkeyItemBuilder setEidAuthkeyItemId(java.lang.String value)
-
setMappingAuthkey
public EidAuthkeyItemBuilder setMappingAuthkey(MappingAuthkey value)
-
addAugmentation
public EidAuthkeyItemBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EidAuthkeyItem> 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 EidAuthkeyItemBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EidAuthkeyItem>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<EidAuthkeyItem> 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 EidAuthkeyItemBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EidAuthkeyItem>> 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 EidAuthkeyItem build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<EidAuthkeyItem>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<EidAuthkeyItem,java.lang.IllegalArgumentException>
-
-