Class LocalPrefBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.LocalPrefBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<LocalPref>
,org.opendaylight.yangtools.concepts.CheckedBuilder<LocalPref,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LocalPrefBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<LocalPref>
Class that buildsLocalPrefBuilder
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:
LocalPrefBuilder createTarget(int fooXyzzy, int barBaz) { return new LocalPrefBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LocalPrefBuilder, 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:
LocalPrefBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description LocalPrefBuilder()
LocalPrefBuilder(LocalPref base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description LocalPrefBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LocalPref> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalPref>>
E$$augmentation(Class<E$$> augmentationType)
LocalPref
build()
org.opendaylight.yangtools.yang.common.Uint32
getPref()
LocalPrefBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalPref>> augmentationType)
Remove an augmentation from this builder's product.LocalPrefBuilder
setPref(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPref(Uint32)
instead.LocalPrefBuilder
setPref(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
LocalPrefBuilder
public LocalPrefBuilder()
-
LocalPrefBuilder
public LocalPrefBuilder(LocalPref base)
-
-
Method Detail
-
getPref
public org.opendaylight.yangtools.yang.common.Uint32 getPref()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalPref>> E$$ augmentation(Class<E$$> augmentationType)
-
setPref
public LocalPrefBuilder setPref(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setPref
@Deprecated(forRemoval=true) public LocalPrefBuilder setPref(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPref(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public LocalPrefBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LocalPref> 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 LocalPrefBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalPref>> 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 LocalPref build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<LocalPref>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<LocalPref,IllegalArgumentException>
-
-