org.apache.hugegraph.api

Class API

java.lang.Object

org.apache.hugegraph.api.API

Direct Known Subclasses:

AuthAPI, CypherAPI, GraphAPI, GraphsAPI, GremlinAPI, JobAPI, MetricsAPI, SchemaAPI, SchemaElementAPI, TaskAPI, TraversersAPI, VariablesAPI, VersionAPI

public abstract class API
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	BATCH_ENCODING
static String	CHARSET
protected RestClient	client
static long	NO_LIMIT
static String	PATH_SPLITOR

Constructor Summary

Constructors

Constructor and Description
API(RestClient client)

Method Summary

Modifier and Type	Method and Description
protected static void	checkLimit(long value, String name)
protected static void	checkOffset(long value)
String	path()
protected void	path(String path)
protected void	path(String pathTemplate, Object... args)
protected abstract String	type()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHARSET

public static final String CHARSET

See Also:

Constant Field Values

BATCH_ENCODING

public static final String BATCH_ENCODING

See Also:

Constant Field Values

NO_LIMIT

public static final long NO_LIMIT

See Also:

Constant Field Values

PATH_SPLITOR

public static final String PATH_SPLITOR

See Also:

Constant Field Values

client

protected final RestClient client

Constructor Detail

API

public API(RestClient client)

Method Detail

path

public String path()

path

protected void path(String path)

path

protected void path(String pathTemplate,
                    Object... args)

type

protected abstract String type()

checkOffset

protected static void checkOffset(long value)

checkLimit

protected static void checkLimit(long value,
                                 String name)