Class TopologyLldpDiscoveryConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.lldp.discovery.config.rev160511.TopologyLldpDiscoveryConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TopologyLldpDiscoveryConfig>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TopologyLldpDiscoveryConfig,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TopologyLldpDiscoveryConfigBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<TopologyLldpDiscoveryConfig>
Class that buildsTopologyLldpDiscoveryConfig
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:
TopologyLldpDiscoveryConfig createTopologyLldpDiscoveryConfig(int fooXyzzy, int barBaz) { return new TopologyLldpDiscoveryConfigBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TopologyLldpDiscoveryConfig, 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 opportunities, 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:
TopologyLldpDiscoveryConfig
,Builder
-
-
Constructor Summary
Constructors Constructor Description TopologyLldpDiscoveryConfigBuilder()
TopologyLldpDiscoveryConfigBuilder(TopologyLldpDiscoveryConfig base)
-
Method Summary
-
-
-
Constructor Detail
-
TopologyLldpDiscoveryConfigBuilder
public TopologyLldpDiscoveryConfigBuilder()
-
TopologyLldpDiscoveryConfigBuilder
public TopologyLldpDiscoveryConfigBuilder(TopologyLldpDiscoveryConfig base)
-
-
Method Detail
-
getLldpSecureKey
public String getLldpSecureKey()
-
getTopologyLldpExpirationInterval
public NonZeroUint32Type getTopologyLldpExpirationInterval()
-
getTopologyLldpInterval
public NonZeroUint32Type getTopologyLldpInterval()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TopologyLldpDiscoveryConfig>> E$$ augmentation(Class<E$$> augmentationType)
-
setLldpSecureKey
public TopologyLldpDiscoveryConfigBuilder setLldpSecureKey(String value)
-
setTopologyLldpExpirationInterval
public TopologyLldpDiscoveryConfigBuilder setTopologyLldpExpirationInterval(NonZeroUint32Type value)
-
setTopologyLldpInterval
public TopologyLldpDiscoveryConfigBuilder setTopologyLldpInterval(NonZeroUint32Type value)
-
addAugmentation
public TopologyLldpDiscoveryConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TopologyLldpDiscoveryConfig> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public TopologyLldpDiscoveryConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TopologyLldpDiscoveryConfig>> 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 TopologyLldpDiscoveryConfig build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TopologyLldpDiscoveryConfig>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TopologyLldpDiscoveryConfig,IllegalArgumentException>
-
-