Class AuthenticationKeyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance.AuthenticationKeyBuilder
-
@Generated("mdsal-binding-generator") public class AuthenticationKeyBuilder extends java.lang.Object
Class that buildsAuthenticationKey
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:
AuthenticationKey createAuthenticationKey(int fooXyzzy, int barBaz) { return new AuthenticationKeyBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AuthenticationKey, 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:
AuthenticationKey
- 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
-
-
Constructor Summary
Constructors Constructor Description AuthenticationKeyBuilder()
Construct an empty builder.AuthenticationKeyBuilder(EidContainer arg)
Construct a new builder initialized from specifiedEidContainer
.AuthenticationKeyBuilder(MappingAuthkeyContainer arg)
Construct a new builder initialized from specifiedMappingAuthkeyContainer
.AuthenticationKeyBuilder(AuthenticationKey base)
Construct a builder initialized with state from specifiedAuthenticationKey
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull AuthenticationKey
build()
A newAuthenticationKey
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Eid
getEid()
Return current value associated with the property corresponding toEidContainer.getEid()
.EidUri
getEidUri()
Return current value associated with the property corresponding toAuthenticationKey.getEidUri()
.MappingAuthkey
getMappingAuthkey()
Return current value associated with the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
.AuthenticationKeyKey
key()
Return current value associated with the property corresponding toAuthenticationKey.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)
Set the property corresponding toEidContainer.getEid()
to the specified value.AuthenticationKeyBuilder
setEidUri(EidUri value)
Set the property corresponding toAuthenticationKey.getEidUri()
to the specified value.AuthenticationKeyBuilder
setMappingAuthkey(MappingAuthkey value)
Set the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
to the specified value.AuthenticationKeyBuilder
withKey(AuthenticationKeyKey key)
-
-
-
Constructor Detail
-
AuthenticationKeyBuilder
public AuthenticationKeyBuilder()
Construct an empty builder.
-
AuthenticationKeyBuilder
public AuthenticationKeyBuilder(EidContainer arg)
Construct a new builder initialized from specifiedEidContainer
.- Parameters:
arg
- EidContainer from which the builder should be initialized
-
AuthenticationKeyBuilder
public AuthenticationKeyBuilder(MappingAuthkeyContainer arg)
Construct a new builder initialized from specifiedMappingAuthkeyContainer
.- Parameters:
arg
- MappingAuthkeyContainer from which the builder should be initialized
-
AuthenticationKeyBuilder
public AuthenticationKeyBuilder(AuthenticationKey base)
Construct a builder initialized with state from specifiedAuthenticationKey
.- Parameters:
base
- AuthenticationKey from which the builder should be initialized
-
-
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:- 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()
Return current value associated with the property corresponding toAuthenticationKey.key()
.- Returns:
- current value
-
getEid
public Eid getEid()
Return current value associated with the property corresponding toEidContainer.getEid()
.- Returns:
- current value
-
getEidUri
public EidUri getEidUri()
Return current value associated with the property corresponding toAuthenticationKey.getEidUri()
.- Returns:
- current value
-
getMappingAuthkey
public 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<AuthenticationKey>> E$$ augmentation(java.lang.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:
java.lang.NullPointerException
- ifaugmentType
isnull
-
withKey
public AuthenticationKeyBuilder withKey(AuthenticationKeyKey key)
-
setEid
public AuthenticationKeyBuilder setEid(Eid value)
Set the property corresponding toEidContainer.getEid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEidUri
public AuthenticationKeyBuilder setEidUri(EidUri value)
Set the property corresponding toAuthenticationKey.getEidUri()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMappingAuthkey
public AuthenticationKeyBuilder setMappingAuthkey(MappingAuthkey value)
Set the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull AuthenticationKey build()
A newAuthenticationKey
instance.- Returns:
- A new
AuthenticationKey
instance.
-
-