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
-
@Generated("mdsal-binding-generator") public class PrefixAttributesBuilder extends Object
Class that buildsPrefixAttributes
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:
PrefixAttributes
- 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 PrefixAttributesBuilder()
Construct an empty builder.PrefixAttributesBuilder(PrefixAttributes base)
Construct a builder initialized with state from specifiedPrefixAttributes
.PrefixAttributesBuilder(PrefixState arg)
Construct a new builder initialized from specifiedPrefixState
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PrefixAttributesBuilder
addAugmentation(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.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Set<ExtendedRouteTag>
getExtendedTags()
Return current value associated with the property corresponding toPrefixState.getExtendedTags()
.IgpBits
getIgpBits()
Return current value associated with the property corresponding toPrefixState.getIgpBits()
.Ipv6SrPrefix
getIpv6SrPrefix()
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
getOspfForwardingAddress()
Return current value associated with the property corresponding toPrefixState.getOspfForwardingAddress()
.IgpMetric
getPrefixMetric()
Return current value associated with the property corresponding toPrefixState.getPrefixMetric()
.Set<RouteTag>
getRouteTags()
Return current value associated with the property corresponding toPrefixState.getRouteTags()
.List<SrBindingSidLabels>
getSrBindingSidLabels()
Return current value associated with the property corresponding toPrefixState.getSrBindingSidLabels()
.SrPrefix
getSrPrefix()
Return current value associated with the property corresponding toPrefixState.getSrPrefix()
.SrRange
getSrRange()
Return current value associated with the property corresponding toPrefixState.getSrRange()
.PrefixAttributesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixAttributes>> augmentationType)
Remove an augmentation from this builder's product.PrefixAttributesBuilder
setExtendedTags(Set<ExtendedRouteTag> values)
Set the property corresponding toPrefixState.getExtendedTags()
to the specified value.PrefixAttributesBuilder
setIgpBits(IgpBits value)
Set the property corresponding toPrefixState.getIgpBits()
to the specified value.PrefixAttributesBuilder
setIpv6SrPrefix(Ipv6SrPrefix value)
Set the property corresponding toPrefixState.getIpv6SrPrefix()
to the specified value.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.PrefixAttributesBuilder
setPrefixMetric(IgpMetric value)
Set the property corresponding toPrefixState.getPrefixMetric()
to the specified value.PrefixAttributesBuilder
setRouteTags(Set<RouteTag> values)
Set the property corresponding toPrefixState.getRouteTags()
to the specified value.PrefixAttributesBuilder
setSrBindingSidLabels(List<SrBindingSidLabels> values)
Set the property corresponding toPrefixState.getSrBindingSidLabels()
to the specified value.PrefixAttributesBuilder
setSrPrefix(SrPrefix value)
Set the property corresponding toPrefixState.getSrPrefix()
to the specified value.PrefixAttributesBuilder
setSrRange(SrRange value)
Set the property corresponding toPrefixState.getSrRange()
to the specified value.
-
-
-
Constructor Detail
-
PrefixAttributesBuilder
public PrefixAttributesBuilder()
Construct an empty builder.
-
PrefixAttributesBuilder
public PrefixAttributesBuilder(PrefixState arg)
Construct a new builder initialized from specifiedPrefixState
.- Parameters:
arg
- PrefixState from which the builder should be initialized
-
PrefixAttributesBuilder
public PrefixAttributesBuilder(PrefixAttributes base)
Construct a builder initialized with state from specifiedPrefixAttributes
.- Parameters:
base
- PrefixAttributes 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
-
getExtendedTags
public Set<ExtendedRouteTag> getExtendedTags()
Return current value associated with the property corresponding toPrefixState.getExtendedTags()
.- Returns:
- current value
-
getIgpBits
public IgpBits getIgpBits()
Return current value associated with the property corresponding toPrefixState.getIgpBits()
.- Returns:
- current value
-
getIpv6SrPrefix
public Ipv6SrPrefix 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
public IgpMetric getPrefixMetric()
Return current value associated with the property corresponding toPrefixState.getPrefixMetric()
.- Returns:
- current value
-
getRouteTags
public Set<RouteTag> getRouteTags()
Return current value associated with the property corresponding toPrefixState.getRouteTags()
.- Returns:
- current value
-
getSrBindingSidLabels
public List<SrBindingSidLabels> getSrBindingSidLabels()
Return current value associated with the property corresponding toPrefixState.getSrBindingSidLabels()
.- Returns:
- current value
-
getSrPrefix
public SrPrefix getSrPrefix()
Return current value associated with the property corresponding toPrefixState.getSrPrefix()
.- Returns:
- current value
-
getSrRange
public SrRange 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
public PrefixAttributesBuilder setExtendedTags(Set<ExtendedRouteTag> values)
Set the property corresponding toPrefixState.getExtendedTags()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setIgpBits
public PrefixAttributesBuilder setIgpBits(IgpBits value)
Set the property corresponding toPrefixState.getIgpBits()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv6SrPrefix
public PrefixAttributesBuilder setIpv6SrPrefix(Ipv6SrPrefix value)
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
public PrefixAttributesBuilder setPrefixMetric(IgpMetric value)
Set the property corresponding toPrefixState.getPrefixMetric()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteTags
public PrefixAttributesBuilder setRouteTags(Set<RouteTag> values)
Set the property corresponding toPrefixState.getRouteTags()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setSrBindingSidLabels
public PrefixAttributesBuilder setSrBindingSidLabels(List<SrBindingSidLabels> values)
Set the property corresponding toPrefixState.getSrBindingSidLabels()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setSrPrefix
public PrefixAttributesBuilder setSrPrefix(SrPrefix value)
Set the property corresponding toPrefixState.getSrPrefix()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSrRange
public PrefixAttributesBuilder setSrRange(SrRange value)
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
public @NonNull PrefixAttributes build()
A newPrefixAttributes
instance.- Returns:
- A new
PrefixAttributes
instance.
-
-