Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.error.messages.grouping

Class ErrorMessagesBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.error.messages.grouping.ErrorMessagesBuilder
@Generated("mdsal-binding-generator") public class ErrorMessagesBuilder extends Object
Class that builds ErrorMessages 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: 

   
     ErrorMessages createErrorMessages(int fooXyzzy, int barBaz) {
         return new ErrorMessagesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ErrorMessagesBuilder

      public ErrorMessagesBuilder()
      Construct an empty builder.

    • ErrorMessagesBuilder

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

  • Method Details

    • empty

      public static @NonNull ErrorMessages empty()
      Get empty instance of ErrorMessages.
      Returns:
      An empty ErrorMessages

    • getLastReceivedError

      public LastReceivedError getLastReceivedError()
      Return current value associated with the property corresponding to ErrorMessages.getLastReceivedError().
      Returns:
      current value

    • getLastSentError

      public LastSentError getLastSentError()
      Return current value associated with the property corresponding to ErrorMessages.getLastSentError().
      Returns:
      current value

    • getReceivedErrorMsgCount

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

    • getSentErrorMsgCount

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

    • augmentation

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

    • setLastReceivedError

      public ErrorMessagesBuilder setLastReceivedError(LastReceivedError value)
      Set the property corresponding to ErrorMessages.getLastReceivedError() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLastSentError

      public ErrorMessagesBuilder setLastSentError(LastSentError value)
      Set the property corresponding to ErrorMessages.getLastSentError() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setReceivedErrorMsgCount

      public ErrorMessagesBuilder setReceivedErrorMsgCount(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to ErrorMessages.getReceivedErrorMsgCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSentErrorMsgCount

      public ErrorMessagesBuilder setSentErrorMsgCount(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to ErrorMessages.getSentErrorMsgCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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