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

Class FromRoleBuilder

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

   
     FromRole createFromRole(int fooXyzzy, int barBaz) {
         return new FromRoleBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • FromRoleBuilder

      public FromRoleBuilder()
      Construct an empty builder.

    • FromRoleBuilder

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

    • FromRoleBuilder

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

    • FromRoleBuilder

      public FromRoleBuilder(FromRole base)
      Construct a builder initialized with state from specified FromRole.
      Parameters:
      base - FromRole 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

    • empty

      public static @NonNull FromRole empty()
      Get empty instance of FromRole.
      Returns:
      An empty FromRole

    • getMatchSetOptions

      public MatchSetOptionsRestrictedType getMatchSetOptions()
      Return current value associated with the property corresponding to MatchSetOptionsRestrictedGroup.getMatchSetOptions().
      Returns:
      current value

    • getRoleSet

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

    • augmentation

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

    • setMatchSetOptions

      public FromRoleBuilder setMatchSetOptions(MatchSetOptionsRestrictedType value)
      Set the property corresponding to MatchSetOptionsRestrictedGroup.getMatchSetOptions() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRoleSet

      public FromRoleBuilder setRoleSet(String value)
      Set the property corresponding to MatchRoleConditionGrouping.getRoleSet() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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