Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.aaa.rev200730.aaa.radius.server.top.radius
Class StateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.aaa.rev200730.aaa.radius.server.top.radius.StateBuilder
-
@Generated("mdsal-binding-generator") public class StateBuilder extends Object
Class that buildsStateinstances. 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:
State createState(int fooXyzzy, int barBaz) { return new StateBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }This pattern is supported by the immutable nature of State, 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:
State
- 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 StateBuilder()Construct an empty builder.StateBuilder(State base)Construct a builder initialized with state from specifiedState.StateBuilder(AaaRadiusServerConfig arg)Construct a new builder initialized from specifiedAaaRadiusServerConfig.StateBuilder(AaaRadiusServerState arg)Construct a new builder initialized from specifiedAaaRadiusServerState.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StateBuilderaddAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<State> augmentation)Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<State>>
E$$augmentation(Class<E$$> augmentationType)Return the specified augmentation, if it is present in this builder.@NonNull Statebuild()A newStateinstance.voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)Set fields from given grouping argument.PortNumbergetAcctPort()Return current value associated with the property corresponding toAaaRadiusServerConfig.getAcctPort().PortNumbergetAuthPort()Return current value associated with the property corresponding toAaaRadiusServerConfig.getAuthPort().CountersgetCounters()Return current value associated with the property corresponding toAaaRadiusServerState.getCounters().org.opendaylight.yangtools.yang.common.Uint8getRetransmitAttempts()Return current value associated with the property corresponding toAaaRadiusServerConfig.getRetransmitAttempts().RoutingPasswordgetSecretKey()Return current value associated with the property corresponding toAaaRadiusServerConfig.getSecretKey().CryptPasswordTypegetSecretKeyHashed()Return current value associated with the property corresponding toAaaRadiusServerConfig.getSecretKeyHashed().IpAddressgetSourceAddress()Return current value associated with the property corresponding toAaaRadiusServerConfig.getSourceAddress().StateBuilderremoveAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType)Remove an augmentation from this builder's product.StateBuildersetAcctPort(PortNumber value)Set the property corresponding toAaaRadiusServerConfig.getAcctPort()to the specified value.StateBuildersetAuthPort(PortNumber value)Set the property corresponding toAaaRadiusServerConfig.getAuthPort()to the specified value.StateBuildersetCounters(Counters value)Set the property corresponding toAaaRadiusServerState.getCounters()to the specified value.StateBuildersetRetransmitAttempts(org.opendaylight.yangtools.yang.common.Uint8 value)Set the property corresponding toAaaRadiusServerConfig.getRetransmitAttempts()to the specified value.StateBuildersetSecretKey(RoutingPassword value)Set the property corresponding toAaaRadiusServerConfig.getSecretKey()to the specified value.StateBuildersetSecretKeyHashed(CryptPasswordType value)Set the property corresponding toAaaRadiusServerConfig.getSecretKeyHashed()to the specified value.StateBuildersetSourceAddress(IpAddress value)Set the property corresponding toAaaRadiusServerConfig.getSourceAddress()to the specified value.
-
-
-
Constructor Detail
-
StateBuilder
public StateBuilder()
Construct an empty builder.
-
StateBuilder
public StateBuilder(AaaRadiusServerConfig arg)
Construct a new builder initialized from specifiedAaaRadiusServerConfig.- Parameters:
arg- AaaRadiusServerConfig from which the builder should be initialized
-
StateBuilder
public StateBuilder(AaaRadiusServerState arg)
Construct a new builder initialized from specifiedAaaRadiusServerState.- Parameters:
arg- AaaRadiusServerState 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
-
getAcctPort
public PortNumber getAcctPort()
Return current value associated with the property corresponding toAaaRadiusServerConfig.getAcctPort().- Returns:
- current value
-
getAuthPort
public PortNumber getAuthPort()
Return current value associated with the property corresponding toAaaRadiusServerConfig.getAuthPort().- Returns:
- current value
-
getCounters
public Counters getCounters()
Return current value associated with the property corresponding toAaaRadiusServerState.getCounters().- Returns:
- current value
-
getRetransmitAttempts
public org.opendaylight.yangtools.yang.common.Uint8 getRetransmitAttempts()
Return current value associated with the property corresponding toAaaRadiusServerConfig.getRetransmitAttempts().- Returns:
- current value
-
getSecretKey
public RoutingPassword getSecretKey()
Return current value associated with the property corresponding toAaaRadiusServerConfig.getSecretKey().- Returns:
- current value
-
getSecretKeyHashed
public CryptPasswordType getSecretKeyHashed()
Return current value associated with the property corresponding toAaaRadiusServerConfig.getSecretKeyHashed().- Returns:
- current value
-
getSourceAddress
public IpAddress getSourceAddress()
Return current value associated with the property corresponding toAaaRadiusServerConfig.getSourceAddress().- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> 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
-
setAcctPort
public StateBuilder setAcctPort(PortNumber value)
Set the property corresponding toAaaRadiusServerConfig.getAcctPort()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setAuthPort
public StateBuilder setAuthPort(PortNumber value)
Set the property corresponding toAaaRadiusServerConfig.getAuthPort()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setCounters
public StateBuilder setCounters(Counters value)
Set the property corresponding toAaaRadiusServerState.getCounters()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setRetransmitAttempts
public StateBuilder setRetransmitAttempts(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toAaaRadiusServerConfig.getRetransmitAttempts()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setSecretKey
public StateBuilder setSecretKey(RoutingPassword value)
Set the property corresponding toAaaRadiusServerConfig.getSecretKey()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setSecretKeyHashed
public StateBuilder setSecretKeyHashed(CryptPasswordType value)
Set the property corresponding toAaaRadiusServerConfig.getSecretKeyHashed()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setSourceAddress
public StateBuilder setSourceAddress(IpAddress value)
Set the property corresponding toAaaRadiusServerConfig.getSourceAddress()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
addAugmentation
public StateBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<State> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException- ifaugmentationis null
-
removeAugmentation
public StateBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> 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
-
-