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
-
@Generated("mdsal-binding-generator") public class OperationsBuilder extends Object
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
- 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 OperationsBuilder()
Construct an empty builder.OperationsBuilder(Operations base)
Construct a builder initialized with state from specifiedOperations
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull Operations
build()
A newOperations
instance.String
getEntityId()
Return current value associated with the property corresponding toOperations.getEntityId()
.Class<? extends EntityNameBase>
getEntityName()
Return current value associated with the property corresponding toOperations.getEntityName()
.Class<? extends EntityTypeBase>
getEntityType()
Return current value associated with the property corresponding toOperations.getEntityType()
.Class<? extends ServiceOpBase>
getTriggerOperation()
Return current value associated with the property corresponding toOperations.getTriggerOperation()
.OperationsKey
key()
Return current value associated with the property corresponding toOperations.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)
Set the property corresponding toOperations.getEntityId()
to the specified value.OperationsBuilder
setEntityName(Class<? extends EntityNameBase> value)
Set the property corresponding toOperations.getEntityName()
to the specified value.OperationsBuilder
setEntityType(Class<? extends EntityTypeBase> value)
Set the property corresponding toOperations.getEntityType()
to the specified value.OperationsBuilder
setTriggerOperation(Class<? extends ServiceOpBase> value)
Set the property corresponding toOperations.getTriggerOperation()
to the specified value.OperationsBuilder
withKey(OperationsKey key)
-
-
-
Constructor Detail
-
OperationsBuilder
public OperationsBuilder()
Construct an empty builder.
-
OperationsBuilder
public OperationsBuilder(Operations base)
Construct a builder initialized with state from specifiedOperations
.- Parameters:
base
- Operations from which the builder should be initialized
-
-
Method Detail
-
key
public OperationsKey key()
Return current value associated with the property corresponding toOperations.key()
.- Returns:
- current value
-
getEntityId
public String getEntityId()
Return current value associated with the property corresponding toOperations.getEntityId()
.- Returns:
- current value
-
getEntityName
public Class<? extends EntityNameBase> getEntityName()
Return current value associated with the property corresponding toOperations.getEntityName()
.- Returns:
- current value
-
getEntityType
public Class<? extends EntityTypeBase> getEntityType()
Return current value associated with the property corresponding toOperations.getEntityType()
.- Returns:
- current value
-
getTriggerOperation
public Class<? extends ServiceOpBase> getTriggerOperation()
Return current value associated with the property corresponding toOperations.getTriggerOperation()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Operations>> E$$ augmentation(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:
NullPointerException
- ifaugmentType
isnull
-
withKey
public OperationsBuilder withKey(OperationsKey key)
-
setEntityId
public OperationsBuilder setEntityId(String value)
Set the property corresponding toOperations.getEntityId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEntityName
public OperationsBuilder setEntityName(Class<? extends EntityNameBase> value)
Set the property corresponding toOperations.getEntityName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEntityType
public OperationsBuilder setEntityType(Class<? extends EntityTypeBase> value)
Set the property corresponding toOperations.getEntityType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTriggerOperation
public OperationsBuilder setTriggerOperation(Class<? extends ServiceOpBase> value)
Set the property corresponding toOperations.getTriggerOperation()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull Operations build()
A newOperations
instance.- Returns:
- A new
Operations
instance.
-
-