Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top
Class RoutingPolicyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.RoutingPolicyBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<RoutingPolicy>
,org.opendaylight.yangtools.concepts.CheckedBuilder<RoutingPolicy,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class RoutingPolicyBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<RoutingPolicy>
Class that buildsRoutingPolicyBuilder
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:
RoutingPolicyBuilder createTarget(int fooXyzzy, int barBaz) { return new RoutingPolicyBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RoutingPolicyBuilder, 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:
RoutingPolicyBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RoutingPolicyBuilder()
RoutingPolicyBuilder(RoutingPolicy base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RoutingPolicyBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RoutingPolicy>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<RoutingPolicy> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RoutingPolicy>>
E$$augmentation(Class<E$$> augmentationType)
RoutingPolicy
build()
DefinedSets
getDefinedSets()
PolicyDefinitions
getPolicyDefinitions()
RoutingPolicyBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RoutingPolicy>> augmentationType)
RoutingPolicyBuilder
setDefinedSets(DefinedSets value)
RoutingPolicyBuilder
setPolicyDefinitions(PolicyDefinitions value)
-
-
-
Constructor Detail
-
RoutingPolicyBuilder
public RoutingPolicyBuilder()
-
RoutingPolicyBuilder
public RoutingPolicyBuilder(RoutingPolicy base)
-
-
Method Detail
-
getDefinedSets
public DefinedSets getDefinedSets()
-
getPolicyDefinitions
public PolicyDefinitions getPolicyDefinitions()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RoutingPolicy>> E$$ augmentation(Class<E$$> augmentationType)
-
setDefinedSets
public RoutingPolicyBuilder setDefinedSets(DefinedSets value)
-
setPolicyDefinitions
public RoutingPolicyBuilder setPolicyDefinitions(PolicyDefinitions value)
-
addAugmentation
public RoutingPolicyBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RoutingPolicy>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<RoutingPolicy> augmentationValue)
-
removeAugmentation
public RoutingPolicyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RoutingPolicy>> augmentationType)
-
build
public RoutingPolicy build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<RoutingPolicy>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<RoutingPolicy,IllegalArgumentException>
-
-