Package org.opends.server.api.plugin

Record Class PluginResult.Startup

java.lang.Object
java.lang.Record
org.opends.server.api.plugin.PluginResult.Startup
Record Components:
continueProcessing - Whether to continue operation processing
continuePluginProcessing - Whether to invoke the rest of the plugins
errorMessage - A message explaining why operation processing startup should stop
Enclosing class:
PluginResult
public static record PluginResult.Startup(boolean continueProcessing, boolean continuePluginProcessing, LocalizableMessage errorMessage) extends Record
Defines a startup plugin result consisting of either continue skip further plugins, or stop startup with an error message.

  • Constructor Details

    • Startup

      public Startup(boolean continueProcessing, boolean continuePluginProcessing, LocalizableMessage errorMessage)
      Creates an instance of a Startup record class.
      Parameters:
      continueProcessing - the value for the continueProcessing record component
      continuePluginProcessing - the value for the continuePluginProcessing record component
      errorMessage - the value for the errorMessage record component

  • Method Details

    • continueStartup

      public static PluginResult.Startup continueStartup()
      Defines a continue processing startup plugin result.
      Returns:
      a continue processing startup plugin result.

    • skipFurtherPluginProcessing

      public static PluginResult.Startup skipFurtherPluginProcessing()
      Defines a skip further plugin processing startup plugin result.
      Returns:
      a skip further plugin processing startup plugin result.

    • stopStartup

      public static PluginResult.Startup stopStartup(LocalizableMessage errorMessage)
      Defines a new stop processing startup plugin result.
      Parameters:
      errorMessage - A message explaining why processing should stop for the given entry.
      Returns:
      a new stop processing startup plugin result.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • continueProcessing

      public boolean continueProcessing()
      Returns the value of the continueProcessing record component.
      Returns:
      the value of the continueProcessing record component

    • continuePluginProcessing

      public boolean continuePluginProcessing()
      Returns the value of the continuePluginProcessing record component.
      Returns:
      the value of the continuePluginProcessing record component

    • errorMessage

      public LocalizableMessage errorMessage()
      Returns the value of the errorMessage record component.
      Returns:
      the value of the errorMessage record component