Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.aaa.rev161214.http.permission

Class PermissionsBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.aaa.rev161214.http.permission.PermissionsBuilder
@Generated("mdsal-binding-generator") public class PermissionsBuilder extends Object
Class that builds Permissions 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: 

   
     Permissions createPermissions(int fooXyzzy, int barBaz) {
         return new PermissionsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PermissionsBuilder

      public PermissionsBuilder()
      Construct an empty builder.

    • PermissionsBuilder

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

  • Method Details

    • getActions

      public Set<Permissions.Actions> getActions()
      Return current value associated with the property corresponding to Permissions.getActions().
      Returns:
      current value

    • getRole

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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Permissions>> 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

    • setActions

      public PermissionsBuilder setActions(Set<Permissions.Actions> values)
      Set the property corresponding to Permissions.getActions() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setRole

      public PermissionsBuilder setRole(String value)
      Set the property corresponding to Permissions.getRole() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public PermissionsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Permissions> 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 PermissionsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Permissions>> 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 Permissions build()
      A new Permissions instance.
      Returns:
      A new Permissions instance.