Class ProtocolEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ProtocolEntry>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ProtocolEntry,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ProtocolEntryBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ProtocolEntry>
Class that buildsProtocolEntryBuilder
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:
ProtocolEntryBuilder createTarget(int fooXyzzy, int barBaz) { return new ProtocolEntryBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ProtocolEntryBuilder, 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:
ProtocolEntryBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ProtocolEntryBuilder()
ProtocolEntryBuilder(ProtocolEntry base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProtocolEntryBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolEntry>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolEntry> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolEntry>>
E$$augmentation(Class<E$$> augmentationType)
ProtocolEntry
build()
Class<? extends OvsdbBridgeProtocolBase>
getProtocol()
ProtocolEntryKey
key()
ProtocolEntryBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolEntry>> augmentationType)
ProtocolEntryBuilder
setProtocol(Class<? extends OvsdbBridgeProtocolBase> value)
ProtocolEntryBuilder
withKey(ProtocolEntryKey key)
-
-
-
Constructor Detail
-
ProtocolEntryBuilder
public ProtocolEntryBuilder()
-
ProtocolEntryBuilder
public ProtocolEntryBuilder(ProtocolEntry base)
-
-
Method Detail
-
key
public ProtocolEntryKey key()
-
getProtocol
public Class<? extends OvsdbBridgeProtocolBase> getProtocol()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolEntry>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public ProtocolEntryBuilder withKey(ProtocolEntryKey key)
-
setProtocol
public ProtocolEntryBuilder setProtocol(Class<? extends OvsdbBridgeProtocolBase> value)
-
addAugmentation
public ProtocolEntryBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolEntry>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolEntry> augmentationValue)
-
removeAugmentation
public ProtocolEntryBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolEntry>> augmentationType)
-
build
public ProtocolEntry build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ProtocolEntry>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ProtocolEntry,IllegalArgumentException>
-
-