Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.role.set

Class RoleSetBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.role.set.RoleSetBuilder
@Generated("mdsal-binding-generator") public class RoleSetBuilder extends Object
Class that builds RoleSet 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: 

   
     RoleSet createRoleSet(int fooXyzzy, int barBaz) {
         return new RoleSetBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • RoleSetBuilder

      public RoleSetBuilder()
      Construct an empty builder.

    • RoleSetBuilder

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

  • Method Details

    • key

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

    • getRole

      public Set<PeerRole> getRole()
      Return current value associated with the property corresponding to RoleSet.getRole().
      Returns:
      current value

    • getRoleSetName

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

    • augmentation

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

    • setRole

      public RoleSetBuilder setRole(Set<PeerRole> values)
      Set the property corresponding to RoleSet.getRole() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setRoleSetName

      public RoleSetBuilder setRoleSetName(String value)
      Set the property corresponding to RoleSet.getRoleSetName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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