Package com.arangodb

Class DbName

java.lang.Object

com.arangodb.DbName

All Implemented Interfaces:

Supplier<String>

public final class DbName
extends Object
implements Supplier<String>

Class to represent a NFC-normalized database name (as required by ArangoDB extended naming convention). To instantiate use of(String) or normalize(String).

See Also:

API Documentation

Field Summary

Fields

Modifier and Type	Field	Description
static DbName	SYSTEM	DbName of the "_system" database.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	get()
String	getEncoded()
int	hashCode()
static DbName	normalize(String value)	Creates a new DbName instance with the NFC normal form of the provided value.
static DbName	of(String value)	Creates a new DbName instance with the provided value.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SYSTEM

public static final DbName SYSTEM

DbName of the "_system" database.

Method Detail

of

public static DbName of(String value)

Creates a new DbName instance with the provided value. If the provided value is not NFC-normalized, throws IllegalArgumentException. No transformation is applied to the provided value. Use normalize(String) to create a DbName from a non-NFC-normalized value.

Parameters:

value - desired db name

Returns:

the created DbName instance

See Also:

NFC normalization, API Documentation

normalize

public static DbName normalize(String value)

Creates a new DbName instance with the NFC normal form of the provided value. Note that the created DbName will hold a value potentially different from the provided one.

Parameters:

value - desired db name

Returns:

the created DbName instance

See Also:

NFC normalization, API Documentation

get

public String get()

Specified by:

get in interface Supplier<String>

getEncoded

public String getEncoded()

Returns:

the value encoded for usage in HTTP urls.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object