java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.esi.esi.as.generated._case.AsGeneratedBuilder

@Generated("mdsal-binding-generator") public class AsGeneratedBuilder extends Object
Class that builds AsGenerated 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:

   
     AsGenerated createAsGenerated(int fooXyzzy, int barBaz) {
         return new AsGeneratedBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • AsGeneratedBuilder

      public AsGeneratedBuilder()
      Construct an empty builder.
    • AsGeneratedBuilder

      public AsGeneratedBuilder(LocalDiscriminator arg)
      Construct a new builder initialized from specified LocalDiscriminator.
      Parameters:
      arg - LocalDiscriminator from which the builder should be initialized
    • AsGeneratedBuilder

      public AsGeneratedBuilder(AsGenerated base)
      Construct a builder initialized with state from specified AsGenerated.
      Parameters:
      base - AsGenerated 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 AsGenerated empty()
      Get empty instance of AsGenerated.
      Returns:
      An empty AsGenerated
    • getAs

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getAs()
      Return current value associated with the property corresponding to AsGenerated.getAs().
      Returns:
      current value
    • getLocalDiscriminator

      public org.opendaylight.yangtools.yang.common.Uint32 getLocalDiscriminator()
      Return current value associated with the property corresponding to LocalDiscriminator.getLocalDiscriminator().
      Returns:
      current value
    • augmentation

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

      public AsGeneratedBuilder setAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
      Set the property corresponding to AsGenerated.getAs() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setLocalDiscriminator

      public AsGeneratedBuilder setLocalDiscriminator(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to LocalDiscriminator.getLocalDiscriminator() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

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