# Uses of Class
org.apache.sis.setup.OptionKey

Packages that use OptionKey
Package
Description
org.apache.sis.setup
Provides information and some controls about Apache SIS configuration.
org.apache.sis.storage
Data store base types for retrieving and saving geospatial data in various storage formats.
org.apache.sis.storage.gdal
Bridge to the GDAL library for reading rasters.
org.apache.sis.storage.geotiff
A data store that can read and write GeoTIFF files as grid coverages.

- ## Uses of OptionKey in org.apache.sis.setup

  Fields in org.apache.sis.setup declared as OptionKey
  Modifier and Type
  Field
  Description
  `static final OptionKey<ByteBuffer>`
  OptionKey.`BYTE_BUFFER`
  Deprecated.
  This option forces unconditional allocation of byte buffer, even if the data store does not use it.
  `static final OptionKey<CoordinateReferenceSystem>`
  OptionKey.`DEFAULT_CRS`
  The coordinate reference system (CRS) of data to use if not explicitly defined.
  `static final OptionKey<Charset>`
  OptionKey.`ENCODING`
  The character encoding of document content.
  `static final OptionKey<GeometryLibrary>`
  OptionKey.`GEOMETRY_LIBRARY`
  The library to use for creating geometric objects at reading time.
  `static final OptionKey<Integer>`
  OptionKey.`INDENTATION`
  The number of spaces to use for indentation when formatting text files in WKT or XML formats.
  `static final OptionKey<Locale>`
  OptionKey.`LOCALE`
  The locale to use for locale-sensitive data.
  `static final OptionKey<OpenOption[]>`
  OptionKey.`OPEN_OPTIONS`
  Whether a storage object shall be opened in read, write, append or other modes.
  `static final OptionKey<ZoneId>`
  OptionKey.`TIMEZONE`
  The timezone to use when parsing or formatting dates and times without explicit timezone.
  `static final OptionKey<String>`
  OptionKey.`URL_ENCODING`
  The encoding of a URL (not the encoding of the document content).
  Methods in org.apache.sis.setup that return types with arguments of type OptionKey
  Modifier and Type
  Method
  Description
  `Map<OptionKey<?>, Object>`
  OptionKey.`setValueInto(Map<OptionKey<?>, Object> options, T value)`
  Sets a value for this option key in the given map, or in a new map if the given map is `null`.
  Method parameters in org.apache.sis.setup with type arguments of type OptionKey
  Modifier and Type
  Method
  Description
  `T`
  OptionKey.`getValueFrom(Map<OptionKey<?>, ?> options)`
  Returns the option value in the given map for this key, or `null` if none.
  `Map<OptionKey<?>, Object>`
  OptionKey.`setValueInto(Map<OptionKey<?>, Object> options, T value)`
  Sets a value for this option key in the given map, or in a new map if the given map is `null`.

- ## Uses of OptionKey in org.apache.sis.storage

  Subclasses of OptionKey in org.apache.sis.storage
  Modifier and Type
  Class
  Description
  `final class`
  `DataOptionKey<T>`
  Keys in a map of options for configuring the way data are read or written to a storage.
  Fields in org.apache.sis.storage declared as OptionKey
  Modifier and Type
  Field
  Description
  `static final OptionKey<CoverageModifier>`
  DataOptionKey.`COVERAGE_MODIFIER`
  Callback methods invoked for modifying some aspects of the grid coverages created by resources.
  `static final OptionKey<FoliationRepresentation>`
  DataOptionKey.`FOLIATION_REPRESENTATION`
  Whether to assemble trajectory fragments (distinct CSV lines) into a single `Feature` instance forming a foliation.
  `static final OptionKey<Path>`
  DataOptionKey.`METADATA_PATH`
  Path to an auxiliary file containing metadata encoded in an ISO 19115-3 XML document.
  `static final OptionKey<StoreListeners>`
  DataOptionKey.`PARENT_LISTENERS`
  The listeners to declare as the parent of the data store listeners.
  Methods in org.apache.sis.storage with parameters of type OptionKey
  Modifier and Type
  Method
  Description
  `<T> T`
  StorageConnector.`getOption(OptionKey<T> key)`
  Returns the option value for the given key, or `null` if none.
  `<T> void`
  StorageConnector.`setOption(OptionKey<T> key, T value)`
  Sets the option value for the given key.

- ## Uses of OptionKey in org.apache.sis.storage.gdal

  Fields in org.apache.sis.storage.gdal declared as OptionKey
  Modifier and Type
  Field
  Description
  `static final OptionKey<String[]>`
  GDALStoreProvider.`DRIVERS_OPTION_KEY`
  Key for declaring GDAL drivers that may be used for opening the file.

- ## Uses of OptionKey in org.apache.sis.storage.geotiff

  Fields in org.apache.sis.storage.geotiff declared as OptionKey
  Modifier and Type
  Field
  Description
  `static final OptionKey<Compression>`
  Compression.`OPTION_KEY`
  The key for declaring the compression at store creation time.
  `static final OptionKey<FormatModifier[]>`
  FormatModifier.`OPTION_KEY`
  The key for declaring GeoTIFF format modifiers at store creation time.