Package org.elasticsearch.cli
Class UserException
java.lang.Object
java.lang.Throwable
java.lang.Exception
org.elasticsearch.cli.UserException
- All Implemented Interfaces:
java.io.Serializable
public class UserException
extends java.lang.Exception
An exception representing a user fixable problem in
Command
usage.- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description int
exitCode
The exist status the cli should use when catching this user error. -
Constructor Summary
Constructors Constructor Description UserException(int exitCode, java.lang.String msg)
Constructs a UserException with an exit status and message to show the user.UserException(int exitCode, java.lang.String msg, java.lang.Throwable cause)
Constructs a new user exception with specified exit status, message, and underlying cause. -
Method Summary
-
Field Details
-
exitCode
public final int exitCodeThe exist status the cli should use when catching this user error.
-
-
Constructor Details
-
UserException
public UserException(int exitCode, java.lang.String msg)Constructs a UserException with an exit status and message to show the user. -
UserException
public UserException(int exitCode, java.lang.String msg, java.lang.Throwable cause)Constructs a new user exception with specified exit status, message, and underlying cause.- Parameters:
exitCode
- the exit codemsg
- the messagecause
- the underlying cause
-