java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.node.ssl.connection.error.service.rev190723.SslErrorBuilder

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

   
     SslError createSslError(int fooXyzzy, int barBaz) {
         return new SslErrorBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • SslErrorBuilder

      public SslErrorBuilder()
      Construct an empty builder.
    • SslErrorBuilder

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

      public SslErrorBuilder(SslError base)
      Construct a builder initialized with state from specified SslError.
      Parameters:
      base - SslError 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
    • getCode

      public org.opendaylight.yangtools.yang.common.Uint16 getCode()
      Return current value associated with the property corresponding to ErrorMessage.getCode().
      Returns:
      current value
    • getData

      public String getData()
      Return current value associated with the property corresponding to ErrorMessage.getData().
      Returns:
      current value
    • getNodeIpAddress

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getNodeIpAddress()
      Return current value associated with the property corresponding to ErrorMessage.getNodeIpAddress().
      Returns:
      current value
    • getSwitchCertificate

      public SwitchCertificate getSwitchCertificate()
      Return current value associated with the property corresponding to SslError.getSwitchCertificate().
      Returns:
      current value
    • getType

      public SslErrorType getType()
      Return current value associated with the property corresponding to ErrorMessage.getType().
      Returns:
      current value
    • augmentation

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

      public SslErrorBuilder setCode(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to ErrorMessage.getCode() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setData

      public SslErrorBuilder setData(String value)
      Set the property corresponding to ErrorMessage.getData() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setNodeIpAddress

      public SslErrorBuilder setNodeIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
      Set the property corresponding to ErrorMessage.getNodeIpAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setSwitchCertificate

      public SslErrorBuilder setSwitchCertificate(SwitchCertificate value)
      Set the property corresponding to SslError.getSwitchCertificate() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setType

      public SslErrorBuilder setType(SslErrorType value)
      Set the property corresponding to ErrorMessage.getType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

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