Class SegmentsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.neutron.networks.network.SegmentsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Segments>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Segments,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SegmentsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Segments>
Class that buildsSegmentsBuilder
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:
SegmentsBuilder createTarget(int fooXyzzy, int barBaz) { return new SegmentsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SegmentsBuilder, 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:
SegmentsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SegmentsBuilder()
SegmentsBuilder(Segments base)
SegmentsBuilder(ProviderAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SegmentsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Segments> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Segments>>
E$$augmentation(Class<E$$> augmentationType)
Segments
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Class<? extends NetworkTypeBase>
getNetworkType()
String
getPhysicalNetwork()
String
getSegmentationId()
org.opendaylight.yangtools.yang.common.Uint32
getSegmentationIndex()
SegmentsKey
key()
SegmentsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Segments>> augmentationType)
Remove an augmentation from this builder's product.SegmentsBuilder
setNetworkType(Class<? extends NetworkTypeBase> value)
SegmentsBuilder
setPhysicalNetwork(String value)
SegmentsBuilder
setSegmentationId(String value)
SegmentsBuilder
setSegmentationIndex(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSegmentationIndex(Uint32)
instead.SegmentsBuilder
setSegmentationIndex(org.opendaylight.yangtools.yang.common.Uint32 value)
SegmentsBuilder
withKey(SegmentsKey key)
-
-
-
Constructor Detail
-
SegmentsBuilder
public SegmentsBuilder()
-
SegmentsBuilder
public SegmentsBuilder(ProviderAttributes arg)
-
SegmentsBuilder
public SegmentsBuilder(Segments 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
-
key
public SegmentsKey key()
-
getNetworkType
public Class<? extends NetworkTypeBase> getNetworkType()
-
getPhysicalNetwork
public String getPhysicalNetwork()
-
getSegmentationId
public String getSegmentationId()
-
getSegmentationIndex
public org.opendaylight.yangtools.yang.common.Uint32 getSegmentationIndex()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Segments>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public SegmentsBuilder withKey(SegmentsKey key)
-
setNetworkType
public SegmentsBuilder setNetworkType(Class<? extends NetworkTypeBase> value)
-
setPhysicalNetwork
public SegmentsBuilder setPhysicalNetwork(String value)
-
setSegmentationId
public SegmentsBuilder setSegmentationId(String value)
-
setSegmentationIndex
public SegmentsBuilder setSegmentationIndex(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSegmentationIndex
@Deprecated(forRemoval=true) public SegmentsBuilder 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
-
addAugmentation
public SegmentsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Segments> 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 SegmentsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Segments>> 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 Segments build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Segments>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Segments,IllegalArgumentException>
-
-