Class AuthenticationKeyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance.AuthenticationKeyBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AuthenticationKey>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AuthenticationKey,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AuthenticationKeyBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<AuthenticationKey>
Class that buildsAuthenticationKeyBuilder
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:
AuthenticationKeyBuilder createTarget(int fooXyzzy, int barBaz) { return new AuthenticationKeyBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AuthenticationKeyBuilder, 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:
AuthenticationKeyBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AuthenticationKeyBuilder()
AuthenticationKeyBuilder(EidContainer arg)
AuthenticationKeyBuilder(MappingAuthkeyContainer arg)
AuthenticationKeyBuilder(AuthenticationKey base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AuthenticationKeyBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AuthenticationKey> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AuthenticationKey>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
AuthenticationKey
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Eid
getEid()
EidUri
getEidUri()
MappingAuthkey
getMappingAuthkey()
AuthenticationKeyKey
key()
AuthenticationKeyBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AuthenticationKey>> augmentationType)
Remove an augmentation from this builder's product.AuthenticationKeyBuilder
setEid(Eid value)
AuthenticationKeyBuilder
setEidUri(EidUri value)
AuthenticationKeyBuilder
setMappingAuthkey(MappingAuthkey value)
AuthenticationKeyBuilder
withKey(AuthenticationKeyKey key)
-
-
-
Constructor Detail
-
AuthenticationKeyBuilder
public AuthenticationKeyBuilder()
-
AuthenticationKeyBuilder
public AuthenticationKeyBuilder(EidContainer arg)
-
AuthenticationKeyBuilder
public AuthenticationKeyBuilder(MappingAuthkeyContainer arg)
-
AuthenticationKeyBuilder
public AuthenticationKeyBuilder(AuthenticationKey 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 or has property with incompatible value
-
key
public AuthenticationKeyKey key()
-
getEid
public Eid getEid()
-
getEidUri
public EidUri getEidUri()
-
getMappingAuthkey
public MappingAuthkey getMappingAuthkey()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AuthenticationKey>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public AuthenticationKeyBuilder withKey(AuthenticationKeyKey key)
-
setEid
public AuthenticationKeyBuilder setEid(Eid value)
-
setEidUri
public AuthenticationKeyBuilder setEidUri(EidUri value)
-
setMappingAuthkey
public AuthenticationKeyBuilder setMappingAuthkey(MappingAuthkey value)
-
addAugmentation
public AuthenticationKeyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AuthenticationKey> 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 AuthenticationKeyBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AuthenticationKey>> 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 AuthenticationKey build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AuthenticationKey>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AuthenticationKey,java.lang.IllegalArgumentException>
-
-