Class PrefixDescriptorsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.object.type.prefix._case.PrefixDescriptorsBuilder
Class that builds
PrefixDescriptors
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:
PrefixDescriptors createPrefixDescriptors(int fooXyzzy, int barBaz) {
return new PrefixDescriptorsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of PrefixDescriptors, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedPrefixDescriptors
.Construct a new builder initialized from specifiedPrefixIdentifiers
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixDescriptors> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixDescriptors>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull PrefixDescriptors
build()
A newPrefixDescriptors
instance.static @NonNull PrefixDescriptors
empty()
Get empty instance of PrefixDescriptors.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
Return current value associated with the property corresponding toPrefixIdentifiers.getIpReachabilityInformation()
.Return current value associated with the property corresponding toPrefixIdentifiers.getMultiTopologyId()
.Return current value associated with the property corresponding toPrefixIdentifiers.getOspfRouteType()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixDescriptors>> augmentationType) Remove an augmentation from this builder's product.setIpReachabilityInformation
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value) Set the property corresponding toPrefixIdentifiers.getIpReachabilityInformation()
to the specified value.Set the property corresponding toPrefixIdentifiers.getMultiTopologyId()
to the specified value.setOspfRouteType
(OspfRouteType value) Set the property corresponding toPrefixIdentifiers.getOspfRouteType()
to the specified value.
-
Constructor Details
-
PrefixDescriptorsBuilder
public PrefixDescriptorsBuilder()Construct an empty builder. -
PrefixDescriptorsBuilder
Construct a new builder initialized from specifiedPrefixIdentifiers
.- Parameters:
arg
- PrefixIdentifiers from which the builder should be initialized
-
PrefixDescriptorsBuilder
Construct a builder initialized with state from specifiedPrefixDescriptors
.- Parameters:
base
- PrefixDescriptors from which the builder should be initialized
-
-
Method Details
-
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
-
empty
Get empty instance of PrefixDescriptors.- Returns:
- An empty
PrefixDescriptors
-
getIpReachabilityInformation
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getIpReachabilityInformation()Return current value associated with the property corresponding toPrefixIdentifiers.getIpReachabilityInformation()
.- Returns:
- current value
-
getMultiTopologyId
Return current value associated with the property corresponding toPrefixIdentifiers.getMultiTopologyId()
.- Returns:
- current value
-
getOspfRouteType
Return current value associated with the property corresponding toPrefixIdentifiers.getOspfRouteType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixDescriptors>> 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
-
setIpReachabilityInformation
public PrefixDescriptorsBuilder setIpReachabilityInformation(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value) Set the property corresponding toPrefixIdentifiers.getIpReachabilityInformation()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMultiTopologyId
Set the property corresponding toPrefixIdentifiers.getMultiTopologyId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOspfRouteType
Set the property corresponding toPrefixIdentifiers.getOspfRouteType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PrefixDescriptorsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixDescriptors> 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 PrefixDescriptorsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixDescriptors>> 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
A newPrefixDescriptors
instance.- Returns:
- A new
PrefixDescriptors
instance.
-