Class ConditionsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.policy.definitions.policy.definition.statements.statement.ConditionsBuilder
-
@Generated("mdsal-binding-generator") public class ConditionsBuilder extends Object
Class that buildsConditions
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:
Conditions createConditions(int fooXyzzy, int barBaz) { return new ConditionsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Conditions, 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:
Conditions
- 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 ConditionsBuilder()
Construct an empty builder.ConditionsBuilder(GenericConditions arg)
Construct a new builder initialized from specifiedGenericConditions
.ConditionsBuilder(IgpConditions arg)
Construct a new builder initialized from specifiedIgpConditions
.ConditionsBuilder(LocalGenericConditions arg)
Construct a new builder initialized from specifiedLocalGenericConditions
.ConditionsBuilder(Conditions base)
Construct a builder initialized with state from specifiedConditions
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ConditionsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Conditions> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Conditions>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Conditions
build()
A newConditions
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getCallPolicy()
Return current value associated with the property corresponding toConditions.getCallPolicy()
.IgpConditions
getIgpConditions()
Return current value associated with the property corresponding toIgpConditions.getIgpConditions()
.Class<? extends InstallProtocolType>
getInstallProtocolEq()
Return current value associated with the property corresponding toLocalGenericConditions.getInstallProtocolEq()
.MatchNeighborSet
getMatchNeighborSet()
Return current value associated with the property corresponding toGenericConditions.getMatchNeighborSet()
.MatchPrefixSet
getMatchPrefixSet()
Return current value associated with the property corresponding toGenericConditions.getMatchPrefixSet()
.MatchTagSet
getMatchTagSet()
Return current value associated with the property corresponding toGenericConditions.getMatchTagSet()
.ConditionsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Conditions>> augmentationType)
Remove an augmentation from this builder's product.ConditionsBuilder
setCallPolicy(String value)
Set the property corresponding toConditions.getCallPolicy()
to the specified value.ConditionsBuilder
setIgpConditions(IgpConditions value)
Set the property corresponding toIgpConditions.getIgpConditions()
to the specified value.ConditionsBuilder
setInstallProtocolEq(Class<? extends InstallProtocolType> value)
Set the property corresponding toLocalGenericConditions.getInstallProtocolEq()
to the specified value.ConditionsBuilder
setMatchNeighborSet(MatchNeighborSet value)
Set the property corresponding toGenericConditions.getMatchNeighborSet()
to the specified value.ConditionsBuilder
setMatchPrefixSet(MatchPrefixSet value)
Set the property corresponding toGenericConditions.getMatchPrefixSet()
to the specified value.ConditionsBuilder
setMatchTagSet(MatchTagSet value)
Set the property corresponding toGenericConditions.getMatchTagSet()
to the specified value.
-
-
-
Constructor Detail
-
ConditionsBuilder
public ConditionsBuilder()
Construct an empty builder.
-
ConditionsBuilder
public ConditionsBuilder(GenericConditions arg)
Construct a new builder initialized from specifiedGenericConditions
.- Parameters:
arg
- GenericConditions from which the builder should be initialized
-
ConditionsBuilder
public ConditionsBuilder(LocalGenericConditions arg)
Construct a new builder initialized from specifiedLocalGenericConditions
.- Parameters:
arg
- LocalGenericConditions from which the builder should be initialized
-
ConditionsBuilder
public ConditionsBuilder(IgpConditions arg)
Construct a new builder initialized from specifiedIgpConditions
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.IgpConditions from which the builder should be initialized
-
ConditionsBuilder
public ConditionsBuilder(Conditions base)
Construct a builder initialized with state from specifiedConditions
.- Parameters:
base
- Conditions 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
-
getCallPolicy
public String getCallPolicy()
Return current value associated with the property corresponding toConditions.getCallPolicy()
.- Returns:
- current value
-
getIgpConditions
public IgpConditions getIgpConditions()
Return current value associated with the property corresponding toIgpConditions.getIgpConditions()
.- Returns:
- current value
-
getInstallProtocolEq
public Class<? extends InstallProtocolType> getInstallProtocolEq()
Return current value associated with the property corresponding toLocalGenericConditions.getInstallProtocolEq()
.- Returns:
- current value
-
getMatchNeighborSet
public MatchNeighborSet getMatchNeighborSet()
Return current value associated with the property corresponding toGenericConditions.getMatchNeighborSet()
.- Returns:
- current value
-
getMatchPrefixSet
public MatchPrefixSet getMatchPrefixSet()
Return current value associated with the property corresponding toGenericConditions.getMatchPrefixSet()
.- Returns:
- current value
-
getMatchTagSet
public MatchTagSet getMatchTagSet()
Return current value associated with the property corresponding toGenericConditions.getMatchTagSet()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Conditions>> 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
-
setCallPolicy
public ConditionsBuilder setCallPolicy(String value)
Set the property corresponding toConditions.getCallPolicy()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIgpConditions
public ConditionsBuilder setIgpConditions(IgpConditions value)
Set the property corresponding toIgpConditions.getIgpConditions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInstallProtocolEq
public ConditionsBuilder setInstallProtocolEq(Class<? extends InstallProtocolType> value)
Set the property corresponding toLocalGenericConditions.getInstallProtocolEq()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatchNeighborSet
public ConditionsBuilder setMatchNeighborSet(MatchNeighborSet value)
Set the property corresponding toGenericConditions.getMatchNeighborSet()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatchPrefixSet
public ConditionsBuilder setMatchPrefixSet(MatchPrefixSet value)
Set the property corresponding toGenericConditions.getMatchPrefixSet()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatchTagSet
public ConditionsBuilder setMatchTagSet(MatchTagSet value)
Set the property corresponding toGenericConditions.getMatchTagSet()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ConditionsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Conditions> 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 ConditionsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Conditions>> 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 Conditions build()
A newConditions
instance.- Returns:
- A new
Conditions
instance.
-
-