Class OspfPseudonodeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.node.identifier.c.router.identifier.ospf.pseudonode._case.OspfPseudonodeBuilder
-
@Generated("mdsal-binding-generator") public class OspfPseudonodeBuilder extends Object
Class that buildsOspfPseudonode
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:
OspfPseudonode createOspfPseudonode(int fooXyzzy, int barBaz) { return new OspfPseudonodeBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OspfPseudonode, 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:
OspfPseudonode
- 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 OspfPseudonodeBuilder()
Construct an empty builder.OspfPseudonodeBuilder(OspfPseudonode base)
Construct a builder initialized with state from specifiedOspfPseudonode
.OspfPseudonodeBuilder(OspfRouterIdentifier arg)
Construct a new builder initialized from specifiedOspfRouterIdentifier
.OspfPseudonodeBuilder(OspfV3LanIdentifier arg)
Construct a new builder initialized from specifiedOspfV3LanIdentifier
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OspfPseudonodeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OspfPseudonode> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfPseudonode>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull OspfPseudonode
build()
A newOspfPseudonode
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.OspfInterfaceIdentifier
getLanInterface()
Return current value associated with the property corresponding toOspfV3LanIdentifier.getLanInterface()
.org.opendaylight.yangtools.yang.common.Uint32
getOspfRouterId()
Return current value associated with the property corresponding toOspfRouterIdentifier.getOspfRouterId()
.OspfPseudonodeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfPseudonode>> augmentationType)
Remove an augmentation from this builder's product.OspfPseudonodeBuilder
setLanInterface(OspfInterfaceIdentifier value)
Set the property corresponding toOspfV3LanIdentifier.getLanInterface()
to the specified value.OspfPseudonodeBuilder
setOspfRouterId(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOspfRouterIdentifier.getOspfRouterId()
to the specified value.
-
-
-
Constructor Detail
-
OspfPseudonodeBuilder
public OspfPseudonodeBuilder()
Construct an empty builder.
-
OspfPseudonodeBuilder
public OspfPseudonodeBuilder(OspfV3LanIdentifier arg)
Construct a new builder initialized from specifiedOspfV3LanIdentifier
.- Parameters:
arg
- OspfV3LanIdentifier from which the builder should be initialized
-
OspfPseudonodeBuilder
public OspfPseudonodeBuilder(OspfRouterIdentifier arg)
Construct a new builder initialized from specifiedOspfRouterIdentifier
.- Parameters:
arg
- OspfRouterIdentifier from which the builder should be initialized
-
OspfPseudonodeBuilder
public OspfPseudonodeBuilder(OspfPseudonode base)
Construct a builder initialized with state from specifiedOspfPseudonode
.- Parameters:
base
- OspfPseudonode 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
-
getLanInterface
public OspfInterfaceIdentifier getLanInterface()
Return current value associated with the property corresponding toOspfV3LanIdentifier.getLanInterface()
.- Returns:
- current value
-
getOspfRouterId
public org.opendaylight.yangtools.yang.common.Uint32 getOspfRouterId()
Return current value associated with the property corresponding toOspfRouterIdentifier.getOspfRouterId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfPseudonode>> 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
-
setLanInterface
public OspfPseudonodeBuilder setLanInterface(OspfInterfaceIdentifier value)
Set the property corresponding toOspfV3LanIdentifier.getLanInterface()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOspfRouterId
public OspfPseudonodeBuilder setOspfRouterId(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOspfRouterIdentifier.getOspfRouterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public OspfPseudonodeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OspfPseudonode> 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 OspfPseudonodeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfPseudonode>> 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 OspfPseudonode build()
A newOspfPseudonode
instance.- Returns:
- A new
OspfPseudonode
instance.
-
-