Class BridgeInterfaceEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.bridge.entry.BridgeInterfaceEntryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BridgeInterfaceEntry>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BridgeInterfaceEntry,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BridgeInterfaceEntryBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<BridgeInterfaceEntry>
Class that buildsBridgeInterfaceEntryBuilder
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:
BridgeInterfaceEntryBuilder createTarget(int fooXyzzy, int barBaz) { return new BridgeInterfaceEntryBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BridgeInterfaceEntryBuilder, 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:
BridgeInterfaceEntryBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BridgeInterfaceEntryBuilder()
BridgeInterfaceEntryBuilder(BridgeInterfaceEntry base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BridgeInterfaceEntryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BridgeInterfaceEntry> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeInterfaceEntry>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
BridgeInterfaceEntry
build()
java.lang.String
getInterfaceName()
BridgeInterfaceEntryKey
key()
BridgeInterfaceEntryBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeInterfaceEntry>> augmentationType)
Remove an augmentation from this builder's product.BridgeInterfaceEntryBuilder
setInterfaceName(java.lang.String value)
BridgeInterfaceEntryBuilder
withKey(BridgeInterfaceEntryKey key)
-
-
-
Constructor Detail
-
BridgeInterfaceEntryBuilder
public BridgeInterfaceEntryBuilder()
-
BridgeInterfaceEntryBuilder
public BridgeInterfaceEntryBuilder(BridgeInterfaceEntry base)
-
-
Method Detail
-
key
public BridgeInterfaceEntryKey key()
-
getInterfaceName
public java.lang.String getInterfaceName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeInterfaceEntry>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public BridgeInterfaceEntryBuilder withKey(BridgeInterfaceEntryKey key)
-
setInterfaceName
public BridgeInterfaceEntryBuilder setInterfaceName(java.lang.String value)
-
addAugmentation
public BridgeInterfaceEntryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BridgeInterfaceEntry> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public BridgeInterfaceEntryBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeInterfaceEntry>> 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 BridgeInterfaceEntry build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BridgeInterfaceEntry>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BridgeInterfaceEntry,java.lang.IllegalArgumentException>
-
-