Class OspfAdjFlagsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev200120.adj.flags.flags.ospf.adj.flags._case.OspfAdjFlagsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<OspfAdjFlags>
,org.opendaylight.yangtools.concepts.CheckedBuilder<OspfAdjFlags,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class OspfAdjFlagsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<OspfAdjFlags>
Class that buildsOspfAdjFlagsBuilder
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:
OspfAdjFlagsBuilder createTarget(int fooXyzzy, int barBaz) { return new OspfAdjFlagsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OspfAdjFlagsBuilder, 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:
OspfAdjFlagsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OspfAdjFlagsBuilder()
OspfAdjFlagsBuilder(OspfAdjFlags base)
OspfAdjFlagsBuilder(OspfAdjFlags arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OspfAdjFlagsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OspfAdjFlags> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfAdjFlags>>
E$$augmentation(Class<E$$> augmentationType)
OspfAdjFlags
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBackup()
Boolean
getSet()
Boolean
isBackup()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isSet()
Deprecated, for removal: This API element is subject to removal in a future version.OspfAdjFlagsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfAdjFlags>> augmentationType)
Remove an augmentation from this builder's product.OspfAdjFlagsBuilder
setBackup(Boolean value)
OspfAdjFlagsBuilder
setSet(Boolean value)
-
-
-
Constructor Detail
-
OspfAdjFlagsBuilder
public OspfAdjFlagsBuilder()
-
OspfAdjFlagsBuilder
public OspfAdjFlagsBuilder(OspfAdjFlags arg)
-
OspfAdjFlagsBuilder
public OspfAdjFlagsBuilder(OspfAdjFlags 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.params.xml.ns.yang.bgp.segment.routing.ext.rev200120.OspfAdjFlags
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBackup
public Boolean getBackup()
-
isBackup
@Deprecated(forRemoval=true) public final Boolean isBackup()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getSet
public Boolean getSet()
-
isSet
@Deprecated(forRemoval=true) public final Boolean isSet()
Deprecated, for removal: This API element is subject to removal in a future version.
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfAdjFlags>> E$$ augmentation(Class<E$$> augmentationType)
-
setBackup
public OspfAdjFlagsBuilder setBackup(Boolean value)
-
setSet
public OspfAdjFlagsBuilder setSet(Boolean value)
-
addAugmentation
public OspfAdjFlagsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OspfAdjFlags> 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 OspfAdjFlagsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfAdjFlags>> 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 OspfAdjFlags build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<OspfAdjFlags>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<OspfAdjFlags,IllegalArgumentException>
-
-