Class ServicesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.serviceutils.srm.ops.rev180626.service.ops.ServicesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Services>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Services,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ServicesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Services>
Class that buildsServicesBuilder
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:
ServicesBuilder createTarget(int fooXyzzy, int barBaz) { return new ServicesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ServicesBuilder, 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:
ServicesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ServicesBuilder()
ServicesBuilder(Services base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ServicesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Services> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Services>>
E$$augmentation(Class<E$$> augmentationType)
Services
build()
Map<OperationsKey,Operations>
getOperations()
Class<? extends EntityNameBase>
getServiceName()
ServicesKey
key()
ServicesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Services>> augmentationType)
Remove an augmentation from this builder's product.ServicesBuilder
setOperations(List<Operations> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOperations(Map)
instead.ServicesBuilder
setOperations(Map<OperationsKey,Operations> values)
ServicesBuilder
setServiceName(Class<? extends EntityNameBase> value)
ServicesBuilder
withKey(ServicesKey key)
-
-
-
Constructor Detail
-
ServicesBuilder
public ServicesBuilder()
-
ServicesBuilder
public ServicesBuilder(Services base)
-
-
Method Detail
-
key
public ServicesKey key()
-
getOperations
public Map<OperationsKey,Operations> getOperations()
-
getServiceName
public Class<? extends EntityNameBase> getServiceName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Services>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public ServicesBuilder withKey(ServicesKey key)
-
setOperations
public ServicesBuilder setOperations(Map<OperationsKey,Operations> values)
-
setOperations
@Deprecated(forRemoval=true) public ServicesBuilder setOperations(List<Operations> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOperations(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
setServiceName
public ServicesBuilder setServiceName(Class<? extends EntityNameBase> value)
-
addAugmentation
public ServicesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Services> 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 ServicesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Services>> 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 Services build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Services>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Services,IllegalArgumentException>
-
-