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

- Packages that use OptionKey
  Package | Description
  --- | ---
  org.apache.sis.setup | Provides information and some controls about SIS configuration.
  org.apache.sis.storage | Data store base types for retrieving and saving geospatial data in various storage formats.

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

    Fields in org.apache.sis.setup declared as OptionKey
    Modifier and Type | Field and Description
    --- | ---
    `static OptionKey<ByteBuffer>` | OptionKey.`BYTE_BUFFER` The byte buffer to use for input/output operations.
    `static OptionKey<Charset>` | OptionKey.`ENCODING` The character encoding of document content.
    `static OptionKey<GeometryLibrary>` | OptionKey.`GEOMETRY_LIBRARY` The library to use for creating geometric objects at reading time.
    `static OptionKey<Integer>` | OptionKey.`INDENTATION` The number of spaces to use for indentation when formatting text files in WKT or XML formats.
    `static OptionKey<Locale>` | OptionKey.`LOCALE` The locale to use for locale-sensitive data.
    `static OptionKey<OpenOption[]>` | OptionKey.`OPEN_OPTIONS` Whether a storage object (e.g. a `DataStore`) shall be opened in read, write, append or other modes.
    `static OptionKey<TimeZone>` | OptionKey.`TIMEZONE` The timezone to use when parsing or formatting dates and times without explicit timezone.
    `static 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 and 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 and 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

    Methods in org.apache.sis.storage with parameters of type OptionKey
    Modifier and Type | Method and 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.

Copyright © 2010–2017 The Apache Software Foundation. All rights reserved.