Class PrefixAttributesBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.path.attribute.link.state.attribute.prefix.attributes._case.PrefixAttributesBuilder
Class that builds
PrefixAttributes
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:
PrefixAttributes createPrefixAttributes(int fooXyzzy, int barBaz) {
return new PrefixAttributesBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of PrefixAttributes, 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 specifiedPrefixAttributes
.Construct a new builder initialized from specifiedPrefixState
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixAttributes> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixAttributes>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull PrefixAttributes
build()
A newPrefixAttributes
instance.static @NonNull PrefixAttributes
empty()
Get empty instance of PrefixAttributes.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toPrefixState.getExtendedTags()
.Return current value associated with the property corresponding toPrefixState.getIgpBits()
.Return current value associated with the property corresponding toPrefixState.getIpv6SrPrefix()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
Return current value associated with the property corresponding toPrefixState.getOspfForwardingAddress()
.Return current value associated with the property corresponding toPrefixState.getPrefixMetric()
.Return current value associated with the property corresponding toPrefixState.getRouteTags()
.Return current value associated with the property corresponding toPrefixState.getSrBindingSidLabels()
.Return current value associated with the property corresponding toPrefixState.getSrPrefix()
.Return current value associated with the property corresponding toPrefixState.getSrRange()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixAttributes>> augmentationType) Remove an augmentation from this builder's product.setExtendedTags
(Set<ExtendedRouteTag> values) Set the property corresponding toPrefixState.getExtendedTags()
to the specified value.setIgpBits
(IgpBits value) Set the property corresponding toPrefixState.getIgpBits()
to the specified value.setIpv6SrPrefix
(Ipv6SrPrefix value) Set the property corresponding toPrefixState.getIpv6SrPrefix()
to the specified value.setOspfForwardingAddress
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value) Set the property corresponding toPrefixState.getOspfForwardingAddress()
to the specified value.setPrefixMetric
(IgpMetric value) Set the property corresponding toPrefixState.getPrefixMetric()
to the specified value.setRouteTags
(Set<RouteTag> values) Set the property corresponding toPrefixState.getRouteTags()
to the specified value.setSrBindingSidLabels
(List<SrBindingSidLabels> values) Set the property corresponding toPrefixState.getSrBindingSidLabels()
to the specified value.setSrPrefix
(SrPrefix value) Set the property corresponding toPrefixState.getSrPrefix()
to the specified value.setSrRange
(SrRange value) Set the property corresponding toPrefixState.getSrRange()
to the specified value.
-
Constructor Details
-
PrefixAttributesBuilder
public PrefixAttributesBuilder()Construct an empty builder. -
PrefixAttributesBuilder
Construct a new builder initialized from specifiedPrefixState
.- Parameters:
arg
- PrefixState from which the builder should be initialized
-
PrefixAttributesBuilder
Construct a builder initialized with state from specifiedPrefixAttributes
.- Parameters:
base
- PrefixAttributes 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 PrefixAttributes.- Returns:
- An empty
PrefixAttributes
-
getExtendedTags
Return current value associated with the property corresponding toPrefixState.getExtendedTags()
.- Returns:
- current value
-
getIgpBits
Return current value associated with the property corresponding toPrefixState.getIgpBits()
.- Returns:
- current value
-
getIpv6SrPrefix
Return current value associated with the property corresponding toPrefixState.getIpv6SrPrefix()
.- Returns:
- current value
-
getOspfForwardingAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getOspfForwardingAddress()Return current value associated with the property corresponding toPrefixState.getOspfForwardingAddress()
.- Returns:
- current value
-
getPrefixMetric
Return current value associated with the property corresponding toPrefixState.getPrefixMetric()
.- Returns:
- current value
-
getRouteTags
Return current value associated with the property corresponding toPrefixState.getRouteTags()
.- Returns:
- current value
-
getSrBindingSidLabels
Return current value associated with the property corresponding toPrefixState.getSrBindingSidLabels()
.- Returns:
- current value
-
getSrPrefix
Return current value associated with the property corresponding toPrefixState.getSrPrefix()
.- Returns:
- current value
-
getSrRange
Return current value associated with the property corresponding toPrefixState.getSrRange()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixAttributes>> 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
-
setExtendedTags
Set the property corresponding toPrefixState.getExtendedTags()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setIgpBits
Set the property corresponding toPrefixState.getIgpBits()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv6SrPrefix
Set the property corresponding toPrefixState.getIpv6SrPrefix()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOspfForwardingAddress
public PrefixAttributesBuilder setOspfForwardingAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value) Set the property corresponding toPrefixState.getOspfForwardingAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrefixMetric
Set the property corresponding toPrefixState.getPrefixMetric()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteTags
Set the property corresponding toPrefixState.getRouteTags()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setSrBindingSidLabels
Set the property corresponding toPrefixState.getSrBindingSidLabels()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setSrPrefix
Set the property corresponding toPrefixState.getSrPrefix()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSrRange
Set the property corresponding toPrefixState.getSrRange()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PrefixAttributesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixAttributes> 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 PrefixAttributesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixAttributes>> 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 newPrefixAttributes
instance.- Returns:
- A new
PrefixAttributes
instance.
-