Package org.opendaylight.yang.gen.v1.urn.opendaylight.serviceutils.srm.ops.rev180626.service.ops

Class ServicesBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.serviceutils.srm.ops.rev180626.service.ops.ServicesBuilder
@Generated("mdsal-binding-generator") public class ServicesBuilder extends Object
Class that builds Services 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: 

   
     Services createServices(int fooXyzzy, int barBaz) {
         return new ServicesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

This pattern is supported by the immutable nature of Services, 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

    • ServicesBuilder

      public ServicesBuilder()
      Construct an empty builder.

    • ServicesBuilder

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

  • Method Details

    • key

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

    • getOperations

      public Map<OperationsKey,Operations> getOperations()
      Return current value associated with the property corresponding to Services.getOperations().
      Returns:
      current value

    • getServiceName

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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Services>> 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 ServicesBuilder withKey(ServicesKey key)
      Set the key value corresponding to Services.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setOperations

      public ServicesBuilder setOperations(Map<OperationsKey,Operations> values)
      Set the property corresponding to Services.getOperations() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setServiceName

      public ServicesBuilder setServiceName(EntityNameBase value)
      Set the property corresponding to Services.getServiceName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • 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 - if augmentation 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 @NonNull Services build()
      A new Services instance.
      Returns:
      A new Services instance.