Class NetworkProviderExtensionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtensionBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NetworkProviderExtension>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NetworkProviderExtension,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NetworkProviderExtensionBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NetworkProviderExtension>
Class that buildsNetworkProviderExtensionBuilder
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:
NetworkProviderExtensionBuilder createTarget(int fooXyzzy, int barBaz) { return new NetworkProviderExtensionBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NetworkProviderExtensionBuilder, 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:
NetworkProviderExtensionBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NetworkProviderExtensionBuilder()
NetworkProviderExtensionBuilder(NetworkProviderExtension base)
NetworkProviderExtensionBuilder(ProviderAttributes arg)
-
Method Summary
-
-
-
Constructor Detail
-
NetworkProviderExtensionBuilder
public NetworkProviderExtensionBuilder()
-
NetworkProviderExtensionBuilder
public NetworkProviderExtensionBuilder(ProviderAttributes arg)
-
NetworkProviderExtensionBuilder
public NetworkProviderExtensionBuilder(NetworkProviderExtension base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.rev150712.ProviderAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getNetworkType
public Class<? extends NetworkTypeBase> getNetworkType()
-
getPhysicalNetwork
public String getPhysicalNetwork()
-
getSegmentationId
public String getSegmentationId()
-
getSegmentationIndex
public org.opendaylight.yangtools.yang.common.Uint32 getSegmentationIndex()
-
getSegments
public Map<SegmentsKey,Segments> getSegments()
-
setNetworkType
public NetworkProviderExtensionBuilder setNetworkType(Class<? extends NetworkTypeBase> value)
-
setPhysicalNetwork
public NetworkProviderExtensionBuilder setPhysicalNetwork(String value)
-
setSegmentationId
public NetworkProviderExtensionBuilder setSegmentationId(String value)
-
setSegmentationIndex
public NetworkProviderExtensionBuilder setSegmentationIndex(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSegmentationIndex
@Deprecated(forRemoval=true) public NetworkProviderExtensionBuilder setSegmentationIndex(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSegmentationIndex(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setSegments
public NetworkProviderExtensionBuilder setSegments(Map<SegmentsKey,Segments> values)
-
setSegments
@Deprecated(forRemoval=true) public NetworkProviderExtensionBuilder setSegments(List<Segments> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSegments(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
build
public NetworkProviderExtension build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NetworkProviderExtension>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NetworkProviderExtension,IllegalArgumentException>
-
-