Class OptionKey<T>
- Type Parameters:
- T- the type of option values.
- All Implemented Interfaces:
- Serializable
- Direct Known Subclasses:
- DataOptionKey
DataStore, etc).
 OptionKeys are used for aspects that usually do not need to be configured, except in a few specialized cases.
 For example, most data file formats read by SIS do not require the user to specify the character encoding, because
 the encoding is often given in the file header or in the format specification. However if SIS needs to read plain
 text files and the default platform encoding is not suitable, then the user can specify the desired encoding
 explicitly using the ENCODING option.
 All options are hints and may be silently ignored. For example, most DataStores will ignore the
 ENCODING option if irrelevant to their format, or if the encoding is specified in the data file header.
Options are transitive: if a service uses others services for its internal working, the given options may also be given to those dependencies, at implementation choice.
Defining new options
Developers who wish to define their own options can define static constants in a subclass, as in the following example:public final class MyOptionKey<T> extends OptionKey<T> {
    public static final OptionKey<String> MY_OPTION = new MyOptionKey<>("MY_OPTION", String.class);
    private MyOptionKey(final String name, final Class<T> type) {
        super(name, type);
    }
}- Since:
- 0.3
- See Also:
Defined in the sis-utility module
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final OptionKey<ByteBuffer>The byte buffer to use for input/output operations.static final OptionKey<Charset>The character encoding of document content.static final OptionKey<GeometryLibrary>The library to use for creating geometric objects at reading time.static final OptionKey<Integer>The number of spaces to use for indentation when formatting text files in WKT or XML formats.static final OptionKey<Locale>The locale to use for locale-sensitive data.static final OptionKey<OpenOption[]>Whether a storage object (e.g. aDataStore) shall be opened in read, write, append or other modes.static final OptionKey<TimeZone>The timezone to use when parsing or formatting dates and times without explicit timezone.static final OptionKey<String>The encoding of a URL (not the encoding of the document content).
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedOptionKey(String name, Class<T> type) Creates a new key of the given name for values of the given type.
- 
Method SummaryModifier and TypeMethodDescriptionbooleanReturnstrueif the given object is an instance of the same class having the same name and type.Returns the type of values associated to this option key.getName()Returns the name of this option key.getValueFrom(Map<OptionKey<?>, ?> options) Returns the option value in the given map for this key, ornullif none.intReturns a hash code value for this object.Map<OptionKey<?>,Object> 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 isnull.Returns a string representation of this option key.
- 
Field Details- 
LOCALEThe locale to use for locale-sensitive data. This option determines the language to use for writinginternational stringswhen the target storage support only one language. It may also control number and date patterns in some file formats like Comma Separated Values (CSV). However, most data formats will ignore this locale.This option is not for the locale of logging or warning messages. Messages locale is rather controlled by DataStore.setLocale(Locale).- Since:
- 0.8
- See Also:
 
- 
TIMEZONEThe timezone to use when parsing or formatting dates and times without explicit timezone. If this option is not provided, then the default value is format specific. That default is often, but not necessarily, the platform default.Upcoming API change — Java time API: the type may be changed toZoneIdwhen Apache SIS will target Java 8. This change may be applied in synchronization with GeoAPI 4.0.- Since:
- 0.8
- See Also:
 
- 
ENCODINGThe character encoding of document content. This option can be used when the file to read does not describe itself its encoding. For example, this option can be used when reading plain text files, but is ignored when reading XML files having a<?xml version="1.0" encoding="…"?>declaration.If this option is not provided, then the default value is format specific. That default is often, but not necessarily, the platform default. - Since:
- 0.4
- See Also:
- 
- Marshaller.JAXB_ENCODING
 
 
- 
URL_ENCODINGThe encoding of a URL (not the encoding of the document content). This option may be used when converting aStringor aURLto aURIor aFile. The following rules apply:- URI are always encoded in UTF-8. Consequently, this option is ignored for URI.
- URL are often encoded in UTF-8, but not necessarily. Other encodings are possible (while not recommended), or some URL may not be encoded at all.
 Example: Given the "file:Map%20with%20spaces.png"URL, then:- If the URL encoding option is set to "UTF-8"or"ISO-8859-1", then:- the encoded URI will be "file:Map%20with%20spaces.png";
- the decoded URI or the file will be "file:Map with spaces.png".
 
- the encoded URI will be 
- If the URL encoding option is set to nullor is not provided, then:- the encoded URI will be "file:Map%2520with%2520spaces.png", i.e. the percent sign will be encoded as"%25";
- the decoded URI or the file will be "file:Map%20with%20spaces.png".
 
- the encoded URI will be 
 - See Also:
 
- 
OPEN_OPTIONSWhether a storage object (e.g. aDataStore) shall be opened in read, write, append or other modes. The main options that can be provided are:Supported open options Value Meaning StandardOpenOption.READOpen for reading data from the storage object. StandardOpenOption.WRITEOpen for modifying existing data in the storage object. StandardOpenOption.APPENDOpen for appending new data in the storage object. StandardOpenOption.CREATECreates a new storage object (file or database) if it does not exist. 
- 
BYTE_BUFFERThe byte buffer to use for input/output operations. SomeDataStoreimplementations allow a byte buffer to be specified, thus allowing users to choose the buffer capacity, whether the buffer is direct, or to recycle existing buffers.It is user's responsibility to ensure that: - The buffer does not contains any valuable data, as it will be cleared.
- The same buffer is not used concurrently by two different DataStoreinstances.
 
- 
GEOMETRY_LIBRARYThe library to use for creating geometric objects at reading time. Some libraries are the Java Topology Suite (JTS), ESRI geometry API and Java2D. If this option is not specified, then a default library will be selected among the libraries available in the runtime environment.- Since:
- 0.8
 
- 
INDENTATIONThe number of spaces to use for indentation when formatting text files in WKT or XML formats. A value of -1 means to format the whole WKT or XML document on a single line without line feeds or indentation.If this option is not provided, then the most typical default value used in Apache SIS is 2. Such small indentation value is used because XML documents defined by OGC standards tend to be verbose. - Since:
- 0.8
- See Also:
- 
- WKTFormat.SINGLE_LINE
- Marshaller.JAXB_FORMATTED_OUTPUT
 
 
 
- 
- 
Constructor Details- 
OptionKeyCreates a new key of the given name for values of the given type.- Parameters:
- name- the key name.
- type- the type of values.
 
 
- 
- 
Method Details- 
getNameReturns the name of this option key.- Returns:
- the name of this option key.
 
- 
getElementTypeReturns the type of values associated to this option key.- Returns:
- the type of values.
 
- 
getValueFromReturns the option value in the given map for this key, ornullif none. This is a convenience method for implementers, which can be used as below:public <T> T getOption(final OptionKey<T> key) { ArgumentChecks.ensureNonNull("key", key); return key.getValueFrom(options); }- Parameters:
- options- the map where to search for the value, or- nullif not yet created.
- Returns:
- the current value in the map for the this option, or nullif none.
 
- 
setValueIntoSets a value for this option key in the given map, or in a new map if the given map isnull. This is a convenience method for implementers, which can be used as below:public <T> void setOption(final OptionKey<T> key, final T value) { ArgumentChecks.ensureNonNull("key", key); options = key.setValueInto(options, value); }- Parameters:
- options- the map where to set the value, or- nullif not yet created.
- value- the new value for the given option, or- nullfor removing the value.
- Returns:
- the given map of options, or a new map if the given map was null. The returned value may be null if the given map and the given value are both null.
 
- 
equalsReturnstrueif the given object is an instance of the same class having the same name and type.
- 
hashCodepublic int hashCode()Returns a hash code value for this object.
- 
toStringReturns a string representation of this option key. The default implementation returns the value ofgetName().
 
-