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 builds Operations 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:

  • Constructor Details

    • OperationsBuilder

      public OperationsBuilder()
      Construct an empty builder.

    • OperationsBuilder

      public OperationsBuilder(Operations base)
      Construct a builder initialized with state from specified Operations.
      Parameters:
      base - Operations from which the builder should be initialized

  • Method Details

    • key

      public OperationsKey key()
      Return current value associated with the property corresponding to Operations.key().
      Returns:
      current value

    • getEntityId

      public String getEntityId()
      Return current value associated with the property corresponding to Operations.getEntityId().
      Returns:
      current value

    • getEntityName

      public EntityNameBase getEntityName()
      Return current value associated with the property corresponding to Operations.getEntityName().
      Returns:
      current value

    • getEntityType

      public EntityTypeBase getEntityType()
      Return current value associated with the property corresponding to Operations.getEntityType().
      Returns:
      current value

    • getTriggerOperation

      public ServiceOpBase getTriggerOperation()
      Return current value associated with the property corresponding to Operations.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 - if augmentType is null

    • withKey

      public OperationsBuilder withKey(OperationsKey key)
      Set the key value corresponding to Operations.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setEntityId

      public OperationsBuilder setEntityId(String value)
      Set the property corresponding to Operations.getEntityId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setEntityName

      public OperationsBuilder setEntityName(EntityNameBase value)
      Set the property corresponding to Operations.getEntityName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setEntityType

      public OperationsBuilder setEntityType(EntityTypeBase value)
      Set the property corresponding to Operations.getEntityType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTriggerOperation

      public OperationsBuilder setTriggerOperation(ServiceOpBase value)
      Set the property corresponding to Operations.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 - if augmentation 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 new Operations instance.
      Returns:
      A new Operations instance.