org.influxdb

Enum InfluxDBFactory

java.lang.Object

java.lang.Enum<InfluxDBFactory>

org.influxdb.InfluxDBFactory

All Implemented Interfaces:

Serializable, Comparable<InfluxDBFactory>

public enum InfluxDBFactory
extends Enum<InfluxDBFactory>

A Factory to create a instance of a InfluxDB Database adapter.

Author:

stefan.majer [at] gmail.com

Method Summary

Methods

Modifier and Type	Method and Description
static InfluxDB	connect(String url, String username, String password) Create a connection to a InfluxDB.
static InfluxDBFactory	valueOf(String name) Returns the enum constant of this type with the specified name.
static InfluxDBFactory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static InfluxDBFactory[] 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 (InfluxDBFactory c : InfluxDBFactory.values())
    System.out.println(c);

Returns:

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

valueOf

public static InfluxDBFactory 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

connect

public static InfluxDB connect(String url,
               String username,
               String password)

Create a connection to a InfluxDB.

Parameters:

url - the url to connect to.

username - the username which is used to authorize against the influxDB instance.

password - the password for the username which is used to authorize against the influxDB instance.

Returns:

a InfluxDB adapter suitable to access a InfluxDB.