Class ServicePathBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.service.path.ServicePathBuilder
-
@Generated("mdsal-binding-generator") public class ServicePathBuilder extends java.lang.Object
Class that buildsServicePath
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:
ServicePath createServicePath(int fooXyzzy, int barBaz) { return new ServicePathBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ServicePath, 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:
ServicePath
- 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 ServicePathBuilder()
Construct an empty builder.ServicePathBuilder(ServicePath base)
Construct a builder initialized with state from specifiedServicePath
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ServicePathBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ServicePath> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ServicePath>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ServicePath
build()
A newServicePath
instance.org.opendaylight.yangtools.yang.common.Uint8
getServiceIndex()
Return current value associated with the property corresponding toServicePath.getServiceIndex()
.ServicePathIdType
getServicePathId()
Return current value associated with the property corresponding toServicePath.getServicePathId()
.ServicePathBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ServicePath>> augmentationType)
Remove an augmentation from this builder's product.ServicePathBuilder
setServiceIndex(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toServicePath.getServiceIndex()
to the specified value.ServicePathBuilder
setServicePathId(ServicePathIdType value)
Set the property corresponding toServicePath.getServicePathId()
to the specified value.
-
-
-
Constructor Detail
-
ServicePathBuilder
public ServicePathBuilder()
Construct an empty builder.
-
ServicePathBuilder
public ServicePathBuilder(ServicePath base)
Construct a builder initialized with state from specifiedServicePath
.- Parameters:
base
- ServicePath from which the builder should be initialized
-
-
Method Detail
-
getServiceIndex
public org.opendaylight.yangtools.yang.common.Uint8 getServiceIndex()
Return current value associated with the property corresponding toServicePath.getServiceIndex()
.- Returns:
- current value
-
getServicePathId
public ServicePathIdType getServicePathId()
Return current value associated with the property corresponding toServicePath.getServicePathId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ServicePath>> E$$ augmentation(java.lang.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:
java.lang.NullPointerException
- ifaugmentType
isnull
-
setServiceIndex
public ServicePathBuilder setServiceIndex(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toServicePath.getServiceIndex()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setServicePathId
public ServicePathBuilder setServicePathId(ServicePathIdType value)
Set the property corresponding toServicePath.getServicePathId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ServicePathBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ServicePath> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public ServicePathBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ServicePath>> 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 ServicePath build()
A newServicePath
instance.- Returns:
- A new
ServicePath
instance.
-
-