Class PathDescriptionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev200120.path.descriptions.PathDescriptionBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PathDescription>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PathDescription,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PathDescriptionBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PathDescription>
Class that buildsPathDescriptionBuilder
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:
PathDescriptionBuilder createTarget(int fooXyzzy, int barBaz) { return new PathDescriptionBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PathDescriptionBuilder, 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 oportunities, 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:
PathDescriptionBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PathDescriptionBuilder()
PathDescriptionBuilder(PathDescription base)
PathDescriptionBuilder(SrDescription arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PathDescriptionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PathDescription> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathDescription>>
E$$augmentation(Class<E$$> augmentationType)
PathDescription
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.Ipv4Address
getIpv4()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address
getIpv6()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address
getLocalIpv4()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address
getLocalIpv6()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address
getRemoteIpv4()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address
getRemoteIpv6()
org.opendaylight.yangtools.yang.common.Uint32
getSid()
PathDescriptionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathDescription>> augmentationType)
Remove an augmentation from this builder's product.PathDescriptionBuilder
setIpv4(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
PathDescriptionBuilder
setIpv6(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
PathDescriptionBuilder
setLocalIpv4(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
PathDescriptionBuilder
setLocalIpv6(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
PathDescriptionBuilder
setRemoteIpv4(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
PathDescriptionBuilder
setRemoteIpv6(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
PathDescriptionBuilder
setSid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSid(Uint32)
instead.PathDescriptionBuilder
setSid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
PathDescriptionBuilder
public PathDescriptionBuilder()
-
PathDescriptionBuilder
public PathDescriptionBuilder(SrDescription arg)
-
PathDescriptionBuilder
public PathDescriptionBuilder(PathDescription 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev200120.SrDescription
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIpv4
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getIpv4()
-
getIpv6
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getIpv6()
-
getLocalIpv4
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getLocalIpv4()
-
getLocalIpv6
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getLocalIpv6()
-
getRemoteIpv4
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getRemoteIpv4()
-
getRemoteIpv6
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getRemoteIpv6()
-
getSid
public org.opendaylight.yangtools.yang.common.Uint32 getSid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathDescription>> E$$ augmentation(Class<E$$> augmentationType)
-
setIpv4
public PathDescriptionBuilder setIpv4(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
-
setIpv6
public PathDescriptionBuilder setIpv6(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
-
setLocalIpv4
public PathDescriptionBuilder setLocalIpv4(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
-
setLocalIpv6
public PathDescriptionBuilder setLocalIpv6(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
-
setRemoteIpv4
public PathDescriptionBuilder setRemoteIpv4(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
-
setRemoteIpv6
public PathDescriptionBuilder setRemoteIpv6(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
-
setSid
public PathDescriptionBuilder setSid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSid
@Deprecated(forRemoval=true) public PathDescriptionBuilder setSid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSid(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public PathDescriptionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PathDescription> 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 PathDescriptionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathDescription>> 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 PathDescription build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PathDescription>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PathDescription,IllegalArgumentException>
-
-