Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.redistribute.protocol
Class OspfBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.redistribute.protocol.OspfBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ospf>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ospf,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class OspfBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Ospf>
Class that buildsOspfBuilder
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:
OspfBuilder createTarget(int fooXyzzy, int barBaz) { return new OspfBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OspfBuilder, 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:
OspfBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OspfBuilder()
OspfBuilder(Ospf base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OspfBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ospf>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ospf> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ospf>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Ospf
build()
java.lang.Boolean
isEnableOspf()
OspfBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ospf>> augmentationType)
OspfBuilder
setEnableOspf(java.lang.Boolean value)
-
-
-
Constructor Detail
-
OspfBuilder
public OspfBuilder()
-
OspfBuilder
public OspfBuilder(Ospf base)
-
-
Method Detail
-
isEnableOspf
public java.lang.Boolean isEnableOspf()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ospf>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setEnableOspf
public OspfBuilder setEnableOspf(java.lang.Boolean value)
-
addAugmentation
public OspfBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ospf>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ospf> augmentationValue)
-
removeAugmentation
public OspfBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ospf>> augmentationType)
-
-