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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PrefixDescriptors>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PrefixDescriptors,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PrefixDescriptorsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PrefixDescriptors>
Class that buildsPrefixDescriptors
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:
PrefixDescriptors
,Builder
-
-
Constructor Summary
Constructors Constructor Description PrefixDescriptorsBuilder()
PrefixDescriptorsBuilder(PrefixDescriptors base)
PrefixDescriptorsBuilder(PrefixIdentifiers arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PrefixDescriptorsBuilder
addAugmentation(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)
PrefixDescriptors
build()
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
getIpReachabilityInformation()
TopologyIdentifier
getMultiTopologyId()
OspfRouteType
getOspfRouteType()
PrefixDescriptorsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixDescriptors>> augmentationType)
Remove an augmentation from this builder's product.PrefixDescriptorsBuilder
setIpReachabilityInformation(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
PrefixDescriptorsBuilder
setMultiTopologyId(TopologyIdentifier value)
PrefixDescriptorsBuilder
setOspfRouteType(OspfRouteType value)
-
-
-
Constructor Detail
-
PrefixDescriptorsBuilder
public PrefixDescriptorsBuilder()
-
PrefixDescriptorsBuilder
public PrefixDescriptorsBuilder(PrefixIdentifiers arg)
-
PrefixDescriptorsBuilder
public PrefixDescriptorsBuilder(PrefixDescriptors base)
-
-
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:- PrefixIdentifiers
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIpReachabilityInformation
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getIpReachabilityInformation()
-
getMultiTopologyId
public TopologyIdentifier getMultiTopologyId()
-
getOspfRouteType
public OspfRouteType getOspfRouteType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixDescriptors>> E$$ augmentation(Class<E$$> augmentationType)
-
setIpReachabilityInformation
public PrefixDescriptorsBuilder setIpReachabilityInformation(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
setMultiTopologyId
public PrefixDescriptorsBuilder setMultiTopologyId(TopologyIdentifier value)
-
setOspfRouteType
public PrefixDescriptorsBuilder setOspfRouteType(OspfRouteType value)
-
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
public PrefixDescriptors build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PrefixDescriptors>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PrefixDescriptors,IllegalArgumentException>
-
-