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
-
@Generated("mdsal-binding-generator") public class OspfPrefixFlagsBuilder extends Object
Class that buildsOspfPrefixFlags
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:
OspfPrefixFlags createOspfPrefixFlags(int fooXyzzy, int barBaz) { return new OspfPrefixFlagsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OspfPrefixFlags, 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 opportunities, 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:
OspfPrefixFlags
- 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
-
-
Constructor Summary
Constructors Constructor Description OspfPrefixFlagsBuilder()
Construct an empty builder.OspfPrefixFlagsBuilder(OspfPrefixFlags base)
Construct a builder initialized with state from specifiedOspfPrefixFlags
.OspfPrefixFlagsBuilder(PrefixFlags arg)
Construct a new builder initialized from specifiedPrefixFlags
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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)
Return the specified augmentation, if it is present in this builder.@NonNull OspfPrefixFlags
build()
A newOspfPrefixFlags
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getExplicitNull()
Return current value associated with the property corresponding toPrefixFlags.getExplicitNull()
.Boolean
getMappingServer()
Return current value associated with the property corresponding toOspfPrefixFlags.getMappingServer()
.Boolean
getNoPhp()
Return current value associated with the property corresponding toPrefixFlags.getNoPhp()
.OspfPrefixFlagsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfPrefixFlags>> augmentationType)
Remove an augmentation from this builder's product.OspfPrefixFlagsBuilder
setExplicitNull(Boolean value)
Set the property corresponding toPrefixFlags.getExplicitNull()
to the specified value.OspfPrefixFlagsBuilder
setMappingServer(Boolean value)
Set the property corresponding toOspfPrefixFlags.getMappingServer()
to the specified value.OspfPrefixFlagsBuilder
setNoPhp(Boolean value)
Set the property corresponding toPrefixFlags.getNoPhp()
to the specified value.
-
-
-
Constructor Detail
-
OspfPrefixFlagsBuilder
public OspfPrefixFlagsBuilder()
Construct an empty builder.
-
OspfPrefixFlagsBuilder
public OspfPrefixFlagsBuilder(PrefixFlags arg)
Construct a new builder initialized from specifiedPrefixFlags
.- Parameters:
arg
- PrefixFlags from which the builder should be initialized
-
OspfPrefixFlagsBuilder
public OspfPrefixFlagsBuilder(OspfPrefixFlags base)
Construct a builder initialized with state from specifiedOspfPrefixFlags
.- Parameters:
base
- OspfPrefixFlags from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getExplicitNull
public Boolean getExplicitNull()
Return current value associated with the property corresponding toPrefixFlags.getExplicitNull()
.- Returns:
- current value
-
getMappingServer
public Boolean getMappingServer()
Return current value associated with the property corresponding toOspfPrefixFlags.getMappingServer()
.- Returns:
- current value
-
getNoPhp
public Boolean getNoPhp()
Return current value associated with the property corresponding toPrefixFlags.getNoPhp()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfPrefixFlags>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setExplicitNull
public OspfPrefixFlagsBuilder setExplicitNull(Boolean value)
Set the property corresponding toPrefixFlags.getExplicitNull()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMappingServer
public OspfPrefixFlagsBuilder setMappingServer(Boolean value)
Set the property corresponding toOspfPrefixFlags.getMappingServer()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNoPhp
public OspfPrefixFlagsBuilder setNoPhp(Boolean value)
Set the property corresponding toPrefixFlags.getNoPhp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
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 @NonNull OspfPrefixFlags build()
A newOspfPrefixFlags
instance.- Returns:
- A new
OspfPrefixFlags
instance.
-
-