Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.defined.sets.bgp.defined.sets.community.sets

Class CommunitySetBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.defined.sets.bgp.defined.sets.community.sets.CommunitySetBuilder
@Generated("mdsal-binding-generator") public class CommunitySetBuilder extends Object
Class that builds CommunitySet 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: 

   
     CommunitySet createCommunitySet(int fooXyzzy, int barBaz) {
         return new CommunitySetBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • CommunitySetBuilder

      public CommunitySetBuilder()
      Construct an empty builder.

    • CommunitySetBuilder

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

  • Method Details

    • key

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

    • getCommunities

      public List<Communities> getCommunities()
      Return current value associated with the property corresponding to CommunitySet.getCommunities().
      Returns:
      current value

    • getCommunitySetName

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

    • augmentation

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

    • setCommunities

      public CommunitySetBuilder setCommunities(List<Communities> values)
      Set the property corresponding to CommunitySet.getCommunities() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setCommunitySetName

      public CommunitySetBuilder setCommunitySetName(String value)
      Set the property corresponding to CommunitySet.getCommunitySetName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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