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

Class PoliciesBuilder

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

   
     Policies createPolicies(int fooXyzzy, int barBaz) {
         return new PoliciesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PoliciesBuilder

      public PoliciesBuilder()
      Construct an empty builder.

    • PoliciesBuilder

      public PoliciesBuilder(HttpPermission arg)
      Construct a new builder initialized from specified HttpPermission.
      Parameters:
      arg - HttpPermission from which the builder should be initialized

    • PoliciesBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
      Set fields from given grouping argument. Valid argument is instance of one of following types:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • key

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

    • getDescription

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

    • getIndex

      public org.opendaylight.yangtools.yang.common.Uint32 getIndex()
      Return current value associated with the property corresponding to HttpPermission.getIndex().
      Returns:
      current value

    • getPermissions

      public List<Permissions> getPermissions()
      Return current value associated with the property corresponding to HttpPermission.getPermissions().
      Returns:
      current value

    • getResource

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

    • augmentation

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

    • setDescription

      public PoliciesBuilder setDescription(String value)
      Set the property corresponding to HttpPermission.getDescription() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIndex

      public PoliciesBuilder setIndex(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to HttpPermission.getIndex() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPermissions

      public PoliciesBuilder setPermissions(List<Permissions> values)
      Set the property corresponding to HttpPermission.getPermissions() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setResource

      public PoliciesBuilder setResource(String value)
      Set the property corresponding to HttpPermission.getResource() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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