/* ***************************************************************************
* $Id: javadoc.java 637961e9df5633b77d011c8e5f53dcab7a58c497 2018-04-20 13:59:35 +0200 Even Rouault $
*
* Project: GDAL/OGR Java bindings
* Purpose: Documentation for the Java bindings
* Author: Even Rouault <even dot rouault at mines dash paris dot org>
*
*******************************************************************************
* Copyright (c) 2009, Even Rouault <even dot rouault at mines dash paris dot org>
* Copyright (c) 1999-2009, Frank Warmerdam
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*************************************************************************** */
/* Class gdal */
/**
* Class gdal is an uninstanciable class providing various utility functions as static methods.
* <p>
* In particular, it provides :
* <ul>
* <li>gdal.<a href="#AllRegister()">AllRegister()</a> and gdal.<a href="#Open(java.lang.String, int)">Open()</a> methods.
* <li>bindings for various GDAL algorithms.
* <li>bindings for some general purpose CPL functions.
* </ul>
*/
public class gdal
/**
* General utility option processing.
*
* This function is intended to provide a variety of generic commandline
* options for all GDAL commandline utilities. It takes care of the following
* commandline options:
* <p><ul>
* <li>--version: report version of GDAL in use.
* <li>--license: report GDAL license info.
* <li>--formats: report all format drivers configured.
* <li>--format [format]: report details of one format driver.
* <li>--optfile filename: expand an option file into the argument list.
* <li>--config key value: set system configuration option.
* <li>--debug [on/off/value]: set debug level.
* <li>--mempreload dir: preload directory contents into /vsimem
* <li>--help-general: report detailed help on general options.
* </ul><p>
* The typical usage looks something like the following. Note that the formats
* should be registered so that the --formats and --format options will work properly.
* <pre>
* public static void main( Strings[] args )
* {
* gdal.AllRegister();
*
* args = gdal.GeneralCmdLineProcessor( args, 0 );
* }
* </pre>
* @param args the argument list array
* @param options currently unused
*
* @return updated argument list array.
*
* @since Java bindings 1.7.0
*/
public class gdal:public static String[] GeneralCmdLineProcessor(String[] args, int options)
/**
* General utility option processing.
*
* Same as below with options == 0
*
* @see #GeneralCmdLineProcessor(String[] args, int options)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static String[] GeneralCmdLineProcessor(String[] args)
/**
* General utility option processing.
*
* Same as below but with arguments as a Vector of strings
*
* @return updated argument list as a new Vector of strings
*
* @see #GeneralCmdLineProcessor(String[] args, int options)
*/
public class gdal:public static java.util.Vector GeneralCmdLineProcessor(java.util.Vector args, int options)
/**
* General utility option processing.
*
* Same as below but with arguments as a Vector of strings and options == 0
*
* @return updated argument list as a new Vector of strings
*
* @see #GeneralCmdLineProcessor(String[] args, int options)
*
* @since Java bindings 1.7.0
*/
public class gdal:public static java.util.Vector GeneralCmdLineProcessor(java.util.Vector args)
/**
* Display a debugging message.
*
* The category argument is used in conjunction with the CPL_DEBUG
* environment variable to establish if the message should be displayed.
* If the CPL_DEBUG environment variable is not set, no debug messages
* are emitted (use Error(gdalconst.CE_Warning,...) to ensure messages are displayed).
* If CPL_DEBUG is set, but is an empty string or the word "ON" then all
* debug messages are shown. Otherwise only messages whose category appears
* somewhere within the CPL_DEBUG value are displayed (as determined by
* strstr()).
* <p>
* Categories are usually an identifier for the subsystem producing the
* error. For instance "GDAL" might be used for the GDAL core, and "TIFF"
* for messages from the TIFF translator.
*
* @param msg_class name of the debugging message category.
* @param message message to display.
*/
public class gdal:public static void Debug(String msg_class, String message)
/**
* Push a new error handler.
*
* This pushes a new error handler on the thread-local error handler
* stack. This handler will be used until removed with gdal.PopErrorHandler().
*
* @param callbackName handler function name : "CPLQuietErrorHandler", "CPLDefaultErrorHandler", "CPLLoggingErrorHandler"
*/
public class gdal:public static int PushErrorHandler(String callbackName)
/**
* Push the quiet error handler.
*
* This pushes a new error handler on the thread-local error handler
* stack. This handler will be used until removed with gdal.PopErrorHandler().
*
* @since Java bindings 1.7.0
*/
public class gdal:public static int PushErrorHandler()
/**
* Set a global error handler.
*
* This installs a global error handler.
*
* Note; if a local handler is already installed with PushErrorHandler(), the global error
* handler will not be used until the last local handler is uninstalled with PopErrorHandler().
*
* @since Java bindings 1.10.0
*
* @param callbackName handler function name : "CPLQuietErrorHandler", "CPLDefaultErrorHandler", "CPLLoggingErrorHandler"
*/
public class gdal:public static int SetErrorHandler(String callbackName)
/**
* Set a quiet global error handler.
*
* This installs a quiet global error handler.
*
* Note; if a local handler is already installed with PushErrorHandler(), the global error
* handler will not be used until the last local handler is uninstalled with PopErrorHandler().
*
* @since Java bindings 1.10.0
*/
public class gdal:public static int SetErrorHandler()
/**
* Report an error.
*
* This function reports an error in a manner that can be hooked
* and reported appropriate by different applications.
* <p>
* The msg_class argument can have the value gdalconst.CE_Warning indicating that the
* message is an informational warning, gdalconst.CE_Failure indicating that the
* action failed, but that normal recover mechanisms will be used or
* CE_Fatal meaning that a fatal error has occurred, and that Error()
* should not return.
* <p>
* The default behaviour of Error() is to report errors to stderr,
* and to abort() after reporting a gdalconst.CE_Fatal error. It is expected that
* some applications will want to suppress error reporting, and will want to
* install a C++ exception, or longjmp() approach to no local fatal error
* recovery.
* <p>
* Regardless of how application error handlers or the