Class AuthenticationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.aaa.rev200730.aaa.authentication.top.AuthenticationBuilder
-
@Generated("mdsal-binding-generator") public class AuthenticationBuilder extends Object
Class that buildsAuthenticationinstances. 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:
Authentication createAuthentication(int fooXyzzy, int barBaz) { return new AuthenticationBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }This pattern is supported by the immutable nature of Authentication, 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:
Authentication
- 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 AuthenticationBuilder()Construct an empty builder.AuthenticationBuilder(Authentication base)Construct a builder initialized with state from specifiedAuthentication.AuthenticationBuilder(AaaAuthenticationAdminTop arg)Construct a new builder initialized from specifiedAaaAuthenticationAdminTop.AuthenticationBuilder(AaaAuthenticationUserTop arg)Construct a new builder initialized from specifiedAaaAuthenticationUserTop.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AuthenticationBuilderaddAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Authentication> augmentation)Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Authentication>>
E$$augmentation(Class<E$$> augmentationType)Return the specified augmentation, if it is present in this builder.@NonNull Authenticationbuild()A newAuthenticationinstance.voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)Set fields from given grouping argument.AdminUsergetAdminUser()Return current value associated with the property corresponding toAaaAuthenticationAdminTop.getAdminUser().ConfiggetConfig()Return current value associated with the property corresponding toAuthentication.getConfig().StategetState()Return current value associated with the property corresponding toAuthentication.getState().UsersgetUsers()Return current value associated with the property corresponding toAaaAuthenticationUserTop.getUsers().AuthenticationBuilderremoveAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Authentication>> augmentationType)Remove an augmentation from this builder's product.AuthenticationBuildersetAdminUser(AdminUser value)Set the property corresponding toAaaAuthenticationAdminTop.getAdminUser()to the specified value.AuthenticationBuildersetConfig(Config value)Set the property corresponding toAuthentication.getConfig()to the specified value.AuthenticationBuildersetState(State value)Set the property corresponding toAuthentication.getState()to the specified value.AuthenticationBuildersetUsers(Users value)Set the property corresponding toAaaAuthenticationUserTop.getUsers()to the specified value.
-
-
-
Constructor Detail
-
AuthenticationBuilder
public AuthenticationBuilder()
Construct an empty builder.
-
AuthenticationBuilder
public AuthenticationBuilder(AaaAuthenticationAdminTop arg)
Construct a new builder initialized from specifiedAaaAuthenticationAdminTop.- Parameters:
arg- AaaAuthenticationAdminTop from which the builder should be initialized
-
AuthenticationBuilder
public AuthenticationBuilder(AaaAuthenticationUserTop arg)
Construct a new builder initialized from specifiedAaaAuthenticationUserTop.- Parameters:
arg- AaaAuthenticationUserTop from which the builder should be initialized
-
AuthenticationBuilder
public AuthenticationBuilder(Authentication base)
Construct a builder initialized with state from specifiedAuthentication.- Parameters:
base- Authentication 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:
IllegalArgumentException- if given argument is none of valid types or has property with incompatible value
-
getAdminUser
public AdminUser getAdminUser()
Return current value associated with the property corresponding toAaaAuthenticationAdminTop.getAdminUser().- Returns:
- current value
-
getConfig
public Config getConfig()
Return current value associated with the property corresponding toAuthentication.getConfig().- Returns:
- current value
-
getState
public State getState()
Return current value associated with the property corresponding toAuthentication.getState().- Returns:
- current value
-
getUsers
public Users getUsers()
Return current value associated with the property corresponding toAaaAuthenticationUserTop.getUsers().- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Authentication>> 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
nullif not present - Throws:
NullPointerException- ifaugmentTypeisnull
-
setAdminUser
public AuthenticationBuilder setAdminUser(AdminUser value)
Set the property corresponding toAaaAuthenticationAdminTop.getAdminUser()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setConfig
public AuthenticationBuilder setConfig(Config value)
Set the property corresponding toAuthentication.getConfig()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setState
public AuthenticationBuilder setState(State value)
Set the property corresponding toAuthentication.getState()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setUsers
public AuthenticationBuilder setUsers(Users value)
Set the property corresponding toAaaAuthenticationUserTop.getUsers()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
addAugmentation
public AuthenticationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Authentication> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException- ifaugmentationis null
-
removeAugmentation
public AuthenticationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Authentication>> 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 Authentication build()
A newAuthenticationinstance.- Returns:
- A new
Authenticationinstance.
-
-