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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Conditions>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Conditions,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ConditionsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Conditions>
Class that buildsConditionsBuilder
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:
ConditionsBuilder createTarget(int fooXyzzy, int barBaz) { return new ConditionsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ConditionsBuilder, 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 oportunities, 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:
ConditionsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ConditionsBuilder()
ConditionsBuilder(GenericConditions arg)
ConditionsBuilder(IgpConditions arg)
ConditionsBuilder(LocalGenericConditions arg)
ConditionsBuilder(Conditions base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ConditionsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Conditions>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Conditions> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.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)
Conditions
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getCallPolicy()
IgpConditions
getIgpConditions()
Class<? extends InstallProtocolType>
getInstallProtocolEq()
MatchNeighborSet
getMatchNeighborSet()
MatchPrefixSet
getMatchPrefixSet()
MatchTagSet
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)
ConditionsBuilder
setIgpConditions(IgpConditions value)
ConditionsBuilder
setInstallProtocolEq(Class<? extends InstallProtocolType> value)
ConditionsBuilder
setMatchNeighborSet(MatchNeighborSet value)
ConditionsBuilder
setMatchPrefixSet(MatchPrefixSet value)
ConditionsBuilder
setMatchTagSet(MatchTagSet value)
-
-
-
Constructor Detail
-
ConditionsBuilder
public ConditionsBuilder()
-
ConditionsBuilder
public ConditionsBuilder(GenericConditions arg)
-
ConditionsBuilder
public ConditionsBuilder(LocalGenericConditions arg)
-
ConditionsBuilder
public ConditionsBuilder(IgpConditions arg)
-
ConditionsBuilder
public ConditionsBuilder(Conditions base)
-
-
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:- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.LocalGenericConditions
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.IgpConditions
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.GenericConditions
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getCallPolicy
public String getCallPolicy()
-
getIgpConditions
public IgpConditions getIgpConditions()
-
getInstallProtocolEq
public Class<? extends InstallProtocolType> getInstallProtocolEq()
-
getMatchNeighborSet
public MatchNeighborSet getMatchNeighborSet()
-
getMatchPrefixSet
public MatchPrefixSet getMatchPrefixSet()
-
getMatchTagSet
public MatchTagSet getMatchTagSet()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Conditions>> E$$ augmentation(Class<E$$> augmentationType)
-
setCallPolicy
public ConditionsBuilder setCallPolicy(String value)
-
setIgpConditions
public ConditionsBuilder setIgpConditions(IgpConditions value)
-
setInstallProtocolEq
public ConditionsBuilder setInstallProtocolEq(Class<? extends InstallProtocolType> value)
-
setMatchNeighborSet
public ConditionsBuilder setMatchNeighborSet(MatchNeighborSet value)
-
setMatchPrefixSet
public ConditionsBuilder setMatchPrefixSet(MatchPrefixSet value)
-
setMatchTagSet
public ConditionsBuilder setMatchTagSet(MatchTagSet value)
-
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
-
addAugmentation
@Deprecated(forRemoval=true) public ConditionsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Conditions>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Conditions> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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 Conditions build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Conditions>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Conditions,IllegalArgumentException>
-
-