io.keikai.client.api

Enum Settings.Key

java.lang.Object

java.lang.Enum<Settings.Key>

io.keikai.client.api.Settings.Key

All Implemented Interfaces:

Serializable, Comparable<Settings.Key>

Enclosing class:

Settings

public static enum Settings.Key
extends Enum<Settings.Key>

The setting keys

Enum Constant Summary

Enum Constants

Enum Constant and Description
API_ENTRY Keikai spreadsheet server API entry.
API_KEY API Key for authentication
CONTEXT_PATH The context path of this client API application.
ROD_PAGE_SIZE A page size for ROD
SPREADSHEET_CONFIG Keikai SpreadsheetConfig settings.
USE_1904 Whether to use 1904 date system
WORKER_POOL_SIZE Keikai spreadsheet worker pool size per instance.

Method Summary

Modifier and Type	Method and Description
static Settings.Key	valueOf(String name) Returns the enum constant of this type with the specified name.
static Settings.Key[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

API_ENTRY

public static final Settings.Key API_ENTRY

Keikai spreadsheet server API entry. (expert only)

USE_1904

public static final Settings.Key USE_1904

Whether to use 1904 date system

ROD_PAGE_SIZE

public static final Settings.Key ROD_PAGE_SIZE

A page size for ROD

API_KEY

public static final Settings.Key API_KEY

API Key for authentication

WORKER_POOL_SIZE

public static final Settings.Key WORKER_POOL_SIZE

Keikai spreadsheet worker pool size per instance. (expert only)

Default: 1

SPREADSHEET_CONFIG

public static final Settings.Key SPREADSHEET_CONFIG

Keikai SpreadsheetConfig settings.

CONTEXT_PATH

public static final Settings.Key CONTEXT_PATH

The context path of this client API application.

Method Detail

values

public static Settings.Key[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Settings.Key c : Settings.Key.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Settings.Key valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null