StbFailureException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.ngengine.stbimage.StbFailureException

All Implemented Interfaces:: Serializable

public class StbFailureException extends RuntimeException

Exception thrown when image decoding fails.

See Also:

Constructor Summary

Constructors

Constructor

Description

StbFailureException(String reason)

Creates a decoder failure with an internal reason.

StbFailureException(String reason, boolean userMessage)

Creates a decoder failure.
Method Summary

Modifier and Type

Method

Description

String

getReason()

Returns the raw failure reason.

boolean

isUserMessage()

Indicates whether the exception message is already user-facing.

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- StbFailureException
  
  public StbFailureException(String reason)
  
  Creates a decoder failure with an internal reason.
  
  Parameters:
  
  reason - failure reason
- StbFailureException
  
  public StbFailureException(String reason, boolean userMessage)
  
  Creates a decoder failure.
  
  Parameters:
  
  reason - failure reason
  
  userMessage - if true, the message is already suitable for direct user display
Method Details
- getReason
  
  public String getReason()
  
  Returns the raw failure reason.
  
  Returns:
  
  reason string
- isUserMessage
  
  public boolean isUserMessage()
  
  Indicates whether the exception message is already user-facing.
  
  Returns:
  
  true when message can be shown directly to end users