Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcep.error.object

Class ErrorObjectBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcep.error.object.ErrorObjectBuilder
@Generated("mdsal-binding-generator") public class ErrorObjectBuilder extends Object
Class that builds ErrorObject 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: 

   
     ErrorObject createErrorObject(int fooXyzzy, int barBaz) {
         return new ErrorObjectBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ErrorObjectBuilder

      public ErrorObjectBuilder()
      Construct an empty builder.

    • ErrorObjectBuilder

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

    • ErrorObjectBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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 ErrorObject empty()
      Get empty instance of ErrorObject.
      Returns:
      An empty ErrorObject

    • getIgnore

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

    • getProcessingRule

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

    • getTlvs

      public Tlvs getTlvs()
      Return current value associated with the property corresponding to ErrorObject.getTlvs().
      Returns:
      current value

    • getType

      public org.opendaylight.yangtools.yang.common.Uint8 getType()
      Return current value associated with the property corresponding to ErrorObject.getType().
      Returns:
      current value

    • getValue

      public org.opendaylight.yangtools.yang.common.Uint8 getValue()
      Return current value associated with the property corresponding to ErrorObject.getValue().
      Returns:
      current value

    • augmentation

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

    • setIgnore

      public ErrorObjectBuilder setIgnore(Boolean value)
      Set the property corresponding to ObjectHeader.getIgnore() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setProcessingRule

      public ErrorObjectBuilder setProcessingRule(Boolean value)
      Set the property corresponding to ObjectHeader.getProcessingRule() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTlvs

      public ErrorObjectBuilder setTlvs(Tlvs value)
      Set the property corresponding to ErrorObject.getTlvs() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setType

      public ErrorObjectBuilder setType(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to ErrorObject.getType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setValue

      public ErrorObjectBuilder setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to ErrorObject.getValue() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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