Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720.pcupd.pcupd.message.updates.path.ero.subobject.subobject.type

Class SrEroTypeBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720.pcupd.pcupd.message.updates.path.ero.subobject.subobject.type.SrEroTypeBuilder
@Generated("mdsal-binding-generator") public class SrEroTypeBuilder extends Object
Class that builds SrEroType 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: 

   
     SrEroType createSrEroType(int fooXyzzy, int barBaz) {
         return new SrEroTypeBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SrEroTypeBuilder

      public SrEroTypeBuilder()
      Construct an empty builder.

    • SrEroTypeBuilder

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

    • SrEroTypeBuilder

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

    • SrEroTypeBuilder

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

    • getCFlag

      public Boolean getCFlag()
      Return current value associated with the property corresponding to SrSubobject.getCFlag().
      Returns:
      current value

    • getMFlag

      public Boolean getMFlag()
      Return current value associated with the property corresponding to SrSubobject.getMFlag().
      Returns:
      current value

    • getNai

      public Nai getNai()
      Return current value associated with the property corresponding to SrSubobject.getNai().
      Returns:
      current value

    • getNaiType

      public NaiType getNaiType()
      Return current value associated with the property corresponding to SrSubobject.getNaiType().
      Returns:
      current value

    • getSid

      public org.opendaylight.yangtools.yang.common.Uint32 getSid()
      Return current value associated with the property corresponding to SrSubobject.getSid().
      Returns:
      current value

    • augmentation

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

    • setCFlag

      public SrEroTypeBuilder setCFlag(Boolean value)
      Set the property corresponding to SrSubobject.getCFlag() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMFlag

      public SrEroTypeBuilder setMFlag(Boolean value)
      Set the property corresponding to SrSubobject.getMFlag() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNai

      public SrEroTypeBuilder setNai(Nai value)
      Set the property corresponding to SrSubobject.getNai() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNaiType

      public SrEroTypeBuilder setNaiType(NaiType value)
      Set the property corresponding to SrSubobject.getNaiType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSid

      public SrEroTypeBuilder setSid(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to SrSubobject.getSid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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