Files
hdf5/java/hdf/hdf5lib/exceptions/HDF5Exception.java
T
Allen Byrne b754dcb8f2 Move Java wrappers to FFM using jextract and java 25 (#5957)
FFM build requires Java 25, Jextract 25.
Generates FFM bindings during configure.
JNI is default when the requirements are not met or can be forced.
Presets added for maven and FFM - JNI is default selection.
Enhanced Maven options will work with either JNI or FFM
New Workflows for testing and maven uploads.
Extensive documentation changes for java.
2025-11-04 14:03:06 -06:00

77 lines
2.4 KiB
Java

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the LICENSE file, which can be found at the root of the source code *
* distribution tree, or in https://www.hdfgroup.org/licenses. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
package hdf.hdf5lib.exceptions;
/**
* \page ERRORS Errors and Exceptions
* The class HDF5Exception returns errors from the Java HDF5 Interface.
*
* Two sub-classes of HDF5Exception are defined:
* <ol>
* <li>
* HDF5LibraryException -- errors raised by the HDF5 library code
* <li>
* HDF5JavaException -- errors raised by the HDF5 Java wrapper code
* </ol>
*
* These exceptions are sub-classed to represent specific error conditions, as
* needed. In particular, HDF5LibraryException has a sub-class for each major
* error code returned by the HDF5 library.
*
* @defgroup JERR HDF5 Library Exception Interface
*
*/
public class HDF5Exception extends RuntimeException {
/**
* the specified detail message of this exception
*/
protected String detailMessage = null;
/**
* @ingroup JERR
*
* Constructs an <code>HDF5Exception</code> with no specified detail
* message.
*/
public HDF5Exception() { super(); }
/**
* @ingroup JERR
*
* Constructs an <code>HDF5Exception</code> with the specified detail
* message.
*
* @param message
* the detail message.
*/
public HDF5Exception(String message)
{
super();
detailMessage = message;
}
/**
* @ingroup JERR
*
* Returns the detail message of this exception
*
* @return the detail message or <code>null</code> if this object does not
* have a detail message.
*/
@Override
public String getMessage()
{
return detailMessage;
}
}