Package org.opendaylight.yang.gen.v1.urn.opendaylight.serviceutils.srm.ops.rev180626.service.ops.services
Class OperationsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.serviceutils.srm.ops.rev180626.service.ops.services.OperationsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Operations>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Operations,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class OperationsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Operations>
Class that buildsOperations
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:
Operations createOperations(int fooXyzzy, int barBaz) { return new OperationsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Operations, 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:
Operations
,Builder
-
-
Constructor Summary
Constructors Constructor Description OperationsBuilder()
OperationsBuilder(Operations base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Operations> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Operations>>
E$$augmentation(Class<E$$> augmentationType)
Operations
build()
String
getEntityId()
Class<? extends EntityNameBase>
getEntityName()
Class<? extends EntityTypeBase>
getEntityType()
Class<? extends ServiceOpBase>
getTriggerOperation()
OperationsKey
key()
OperationsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Operations>> augmentationType)
Remove an augmentation from this builder's product.OperationsBuilder
setEntityId(String value)
OperationsBuilder
setEntityName(Class<? extends EntityNameBase> value)
OperationsBuilder
setEntityType(Class<? extends EntityTypeBase> value)
OperationsBuilder
setTriggerOperation(Class<? extends ServiceOpBase> value)
OperationsBuilder
withKey(OperationsKey key)
-
-
-
Constructor Detail
-
OperationsBuilder
public OperationsBuilder()
-
OperationsBuilder
public OperationsBuilder(Operations base)
-
-
Method Detail
-
key
public OperationsKey key()
-
getEntityId
public String getEntityId()
-
getEntityName
public Class<? extends EntityNameBase> getEntityName()
-
getEntityType
public Class<? extends EntityTypeBase> getEntityType()
-
getTriggerOperation
public Class<? extends ServiceOpBase> getTriggerOperation()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Operations>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public OperationsBuilder withKey(OperationsKey key)
-
setEntityId
public OperationsBuilder setEntityId(String value)
-
setEntityName
public OperationsBuilder setEntityName(Class<? extends EntityNameBase> value)
-
setEntityType
public OperationsBuilder setEntityType(Class<? extends EntityTypeBase> value)
-
setTriggerOperation
public OperationsBuilder setTriggerOperation(Class<? extends ServiceOpBase> value)
-
addAugmentation
public OperationsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Operations> 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 OperationsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Operations>> 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 Operations build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Operations>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Operations,IllegalArgumentException>
-
-