Class OspfPrefixFlagsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev200120.prefix.sid.tlv.flags.ospf.prefix.flags._case.OspfPrefixFlagsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<OspfPrefixFlags>
,org.opendaylight.yangtools.concepts.CheckedBuilder<OspfPrefixFlags,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class OspfPrefixFlagsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<OspfPrefixFlags>
Class that buildsOspfPrefixFlagsBuilder
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:
OspfPrefixFlagsBuilder createTarget(int fooXyzzy, int barBaz) { return new OspfPrefixFlagsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OspfPrefixFlagsBuilder, 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:
OspfPrefixFlagsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OspfPrefixFlagsBuilder()
OspfPrefixFlagsBuilder(OspfPrefixFlags base)
OspfPrefixFlagsBuilder(PrefixFlags arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OspfPrefixFlagsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfPrefixFlags>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<OspfPrefixFlags> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.OspfPrefixFlagsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OspfPrefixFlags> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfPrefixFlags>>
E$$augmentation(Class<E$$> augmentationType)
OspfPrefixFlags
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
isExplicitNull()
Boolean
isMappingServer()
Boolean
isNoPhp()
OspfPrefixFlagsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfPrefixFlags>> augmentationType)
Remove an augmentation from this builder's product.OspfPrefixFlagsBuilder
setExplicitNull(Boolean value)
OspfPrefixFlagsBuilder
setMappingServer(Boolean value)
OspfPrefixFlagsBuilder
setNoPhp(Boolean value)
-
-
-
Constructor Detail
-
OspfPrefixFlagsBuilder
public OspfPrefixFlagsBuilder()
-
OspfPrefixFlagsBuilder
public OspfPrefixFlagsBuilder(PrefixFlags arg)
-
OspfPrefixFlagsBuilder
public OspfPrefixFlagsBuilder(OspfPrefixFlags 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.PrefixFlags
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
isExplicitNull
public Boolean isExplicitNull()
-
isMappingServer
public Boolean isMappingServer()
-
isNoPhp
public Boolean isNoPhp()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfPrefixFlags>> E$$ augmentation(Class<E$$> augmentationType)
-
setExplicitNull
public OspfPrefixFlagsBuilder setExplicitNull(Boolean value)
-
setMappingServer
public OspfPrefixFlagsBuilder setMappingServer(Boolean value)
-
setNoPhp
public OspfPrefixFlagsBuilder setNoPhp(Boolean value)
-
addAugmentation
public OspfPrefixFlagsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OspfPrefixFlags> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public OspfPrefixFlagsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfPrefixFlags>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<OspfPrefixFlags> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public OspfPrefixFlagsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfPrefixFlags>> 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 OspfPrefixFlags build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<OspfPrefixFlags>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<OspfPrefixFlags,IllegalArgumentException>
-
-