Top Fields Constructors Methods
com.github.luben.zstd

public Class ZstdException

extends RuntimeException
Class Inheritance

Field Summary

Modifier and TypeField and Description
private long

Constructor Summary

AccessConstructor and Description
public
ZstdException(long
the return value of a Zstd library call
result
)

Construct a ZstdException from the result of a Zstd library call.

public
ZstdException(long
a Zstd error code
code
,
String
the exception's message
message
)

Construct a ZstdException with a manually-specified error code and message.

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

a Zstd error code
getErrorCode
()

Get the Zstd error code that caused the exception.

Field Detail

codeback to summary
private long code

Constructor Detail

ZstdExceptionback to summary
public ZstdException(long result)

Construct a ZstdException from the result of a Zstd library call. The error code and message are automatically looked up using Zstd.getErrorCode and Zstd.getErrorName.

Parameters
result:long

the return value of a Zstd library call

ZstdExceptionback to summary
public ZstdException(long code, String message)

Construct a ZstdException with a manually-specified error code and message. No transformation of either the code or message is done. It is advised that one of the Zstd.err*() is used to obtain a stable error code.

Parameters
code:long

a Zstd error code

message:String

the exception's message

Method Detail

getErrorCodeback to summary
public long getErrorCode()

Get the Zstd error code that caused the exception. This will likely correspond to one of the Zstd.err*() methods, but the Zstd library may return error codes that are not yet stable. In such cases, this method will return the code reported by Zstd, but it will not correspond to any of the Zstd.err*() methods.

Returns:long

a Zstd error code