Class StateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.StateBuilder
-
@Generated("mdsal-binding-generator") public class StateBuilder extends Object
Class that buildsState
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:
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(BgpNeighborConfig arg)
Construct a new builder initialized from specifiedBgpNeighborConfig
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StateBuilder
addAugmentation(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 State
build()
A newState
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getAuthPassword()
Return current value associated with the property corresponding toBgpNeighborConfig.getAuthPassword()
.String
getDescription()
Return current value associated with the property corresponding toBgpNeighborConfig.getDescription()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
getLocalAs()
Return current value associated with the property corresponding toBgpNeighborConfig.getLocalAs()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
getPeerAs()
Return current value associated with the property corresponding toBgpNeighborConfig.getPeerAs()
.PeerType
getPeerType()
Return current value associated with the property corresponding toBgpNeighborConfig.getPeerType()
.RemovePrivateAsOption
getRemovePrivateAs()
Return current value associated with the property corresponding toBgpNeighborConfig.getRemovePrivateAs()
.Boolean
getRouteFlapDamping()
Return current value associated with the property corresponding toBgpNeighborConfig.getRouteFlapDamping()
.CommunityType
getSendCommunity()
Return current value associated with the property corresponding toBgpNeighborConfig.getSendCommunity()
.StateBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType)
Remove an augmentation from this builder's product.StateBuilder
setAuthPassword(String value)
Set the property corresponding toBgpNeighborConfig.getAuthPassword()
to the specified value.StateBuilder
setDescription(String value)
Set the property corresponding toBgpNeighborConfig.getDescription()
to the specified value.StateBuilder
setLocalAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
Set the property corresponding toBgpNeighborConfig.getLocalAs()
to the specified value.StateBuilder
setPeerAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
Set the property corresponding toBgpNeighborConfig.getPeerAs()
to the specified value.StateBuilder
setPeerType(PeerType value)
Set the property corresponding toBgpNeighborConfig.getPeerType()
to the specified value.StateBuilder
setRemovePrivateAs(RemovePrivateAsOption value)
Set the property corresponding toBgpNeighborConfig.getRemovePrivateAs()
to the specified value.StateBuilder
setRouteFlapDamping(Boolean value)
Set the property corresponding toBgpNeighborConfig.getRouteFlapDamping()
to the specified value.StateBuilder
setSendCommunity(CommunityType value)
Set the property corresponding toBgpNeighborConfig.getSendCommunity()
to the specified value.
-
-
-
Constructor Detail
-
StateBuilder
public StateBuilder()
Construct an empty builder.
-
StateBuilder
public StateBuilder(BgpNeighborConfig arg)
Construct a new builder initialized from specifiedBgpNeighborConfig
.- Parameters:
arg
- BgpNeighborConfig 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
-
getAuthPassword
public String getAuthPassword()
Return current value associated with the property corresponding toBgpNeighborConfig.getAuthPassword()
.- Returns:
- current value
-
getDescription
public String getDescription()
Return current value associated with the property corresponding toBgpNeighborConfig.getDescription()
.- Returns:
- current value
-
getLocalAs
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getLocalAs()
Return current value associated with the property corresponding toBgpNeighborConfig.getLocalAs()
.- Returns:
- current value
-
getPeerAs
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getPeerAs()
Return current value associated with the property corresponding toBgpNeighborConfig.getPeerAs()
.- Returns:
- current value
-
getPeerType
public PeerType getPeerType()
Return current value associated with the property corresponding toBgpNeighborConfig.getPeerType()
.- Returns:
- current value
-
getRemovePrivateAs
public RemovePrivateAsOption getRemovePrivateAs()
Return current value associated with the property corresponding toBgpNeighborConfig.getRemovePrivateAs()
.- Returns:
- current value
-
getRouteFlapDamping
public Boolean getRouteFlapDamping()
Return current value associated with the property corresponding toBgpNeighborConfig.getRouteFlapDamping()
.- Returns:
- current value
-
getSendCommunity
public CommunityType getSendCommunity()
Return current value associated with the property corresponding toBgpNeighborConfig.getSendCommunity()
.- 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
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setAuthPassword
public StateBuilder setAuthPassword(String value)
Set the property corresponding toBgpNeighborConfig.getAuthPassword()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDescription
public StateBuilder setDescription(String value)
Set the property corresponding toBgpNeighborConfig.getDescription()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocalAs
public StateBuilder setLocalAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
Set the property corresponding toBgpNeighborConfig.getLocalAs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerAs
public StateBuilder setPeerAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
Set the property corresponding toBgpNeighborConfig.getPeerAs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerType
public StateBuilder setPeerType(PeerType value)
Set the property corresponding toBgpNeighborConfig.getPeerType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRemovePrivateAs
public StateBuilder setRemovePrivateAs(RemovePrivateAsOption value)
Set the property corresponding toBgpNeighborConfig.getRemovePrivateAs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteFlapDamping
public StateBuilder setRouteFlapDamping(Boolean value)
Set the property corresponding toBgpNeighborConfig.getRouteFlapDamping()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSendCommunity
public StateBuilder setSendCommunity(CommunityType value)
Set the property corresponding toBgpNeighborConfig.getSendCommunity()
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
- ifaugmentation
is 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
-
-