Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.symbolic.path.name.tlv

Class SymbolicPathNameBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.symbolic.path.name.tlv.SymbolicPathNameBuilder
@Generated("mdsal-binding-generator") public class SymbolicPathNameBuilder extends Object
Class that builds SymbolicPathName 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: 

   
     SymbolicPathName createSymbolicPathName(int fooXyzzy, int barBaz) {
         return new SymbolicPathNameBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SymbolicPathNameBuilder

      public SymbolicPathNameBuilder()
      Construct an empty builder.

    • SymbolicPathNameBuilder

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

    • SymbolicPathNameBuilder

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

    • getPathName

      public SymbolicPathName getPathName()
      Return current value associated with the property corresponding to SymbolicPathName.getPathName().
      Returns:
      current value

    • augmentation

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

    • setPathName

      public SymbolicPathNameBuilder setPathName(SymbolicPathName value)
      Set the property corresponding to SymbolicPathName.getPathName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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