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
Class that builds
Conditions
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedGenericConditions
.Construct a new builder initialized from specifiedIgpConditions
.Construct a new builder initialized from specifiedLocalGenericConditions
.ConditionsBuilder
(Conditions base) Construct a builder initialized with state from specifiedConditions
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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.static @NonNull Conditions
empty()
Get empty instance of Conditions.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toConditions.getCallPolicy()
.Return current value associated with the property corresponding toIgpConditions.getIgpConditions()
.Return current value associated with the property corresponding toLocalGenericConditions.getInstallProtocolEq()
.Return current value associated with the property corresponding toGenericConditions.getMatchNeighborSet()
.Return current value associated with the property corresponding toGenericConditions.getMatchPrefixSet()
.Return current value associated with the property corresponding toGenericConditions.getMatchTagSet()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Conditions>> augmentationType) Remove an augmentation from this builder's product.setCallPolicy
(String value) Set the property corresponding toConditions.getCallPolicy()
to the specified value.setIgpConditions
(IgpConditions value) Set the property corresponding toIgpConditions.getIgpConditions()
to the specified value.Set the property corresponding toLocalGenericConditions.getInstallProtocolEq()
to the specified value.Set the property corresponding toGenericConditions.getMatchNeighborSet()
to the specified value.setMatchPrefixSet
(MatchPrefixSet value) Set the property corresponding toGenericConditions.getMatchPrefixSet()
to the specified value.setMatchTagSet
(MatchTagSet value) Set the property corresponding toGenericConditions.getMatchTagSet()
to the specified value.
-
Constructor Details
-
ConditionsBuilder
public ConditionsBuilder()Construct an empty builder. -
ConditionsBuilder
Construct a new builder initialized from specifiedGenericConditions
.- Parameters:
arg
- GenericConditions from which the builder should be initialized
-
ConditionsBuilder
Construct a new builder initialized from specifiedLocalGenericConditions
.- Parameters:
arg
- LocalGenericConditions from which the builder should be initialized
-
ConditionsBuilder
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
Construct a builder initialized with state from specifiedConditions
.- Parameters:
base
- Conditions from which the builder should be initialized
-
-
Method Details
-
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
-
empty
Get empty instance of Conditions.- Returns:
- An empty
Conditions
-
getCallPolicy
Return current value associated with the property corresponding toConditions.getCallPolicy()
.- Returns:
- current value
-
getIgpConditions
Return current value associated with the property corresponding toIgpConditions.getIgpConditions()
.- Returns:
- current value
-
getInstallProtocolEq
Return current value associated with the property corresponding toLocalGenericConditions.getInstallProtocolEq()
.- Returns:
- current value
-
getMatchNeighborSet
Return current value associated with the property corresponding toGenericConditions.getMatchNeighborSet()
.- Returns:
- current value
-
getMatchPrefixSet
Return current value associated with the property corresponding toGenericConditions.getMatchPrefixSet()
.- Returns:
- current value
-
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
Set the property corresponding toConditions.getCallPolicy()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIgpConditions
Set the property corresponding toIgpConditions.getIgpConditions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInstallProtocolEq
Set the property corresponding toLocalGenericConditions.getInstallProtocolEq()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatchNeighborSet
Set the property corresponding toGenericConditions.getMatchNeighborSet()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatchPrefixSet
Set the property corresponding toGenericConditions.getMatchPrefixSet()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatchTagSet
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
A newConditions
instance.- Returns:
- A new
Conditions
instance.
-