Skip to content

Commit dda8575

Browse files
rashtaorashtao
committed
deprecated DbName (DE-508)
1 parent 08f31ed commit dda8575

File tree

8 files changed

+29
-22
lines changed

8 files changed

+29
-22
lines changed

‎ChangeLog.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
66

77
## [Unreleased]
88

9+
- deprecated `DbName` in favor of plain strings
10+
911
## [6.22.0] - 2023-04-18
1012

1113
- added support to `forceOneShardAttributeValue` query parameter (DE-541)

‎src/main/java/com/arangodb/ArangoDB.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -753,9 +753,7 @@ public synchronized ArangoDB build() {
753753
*
754754
* @param name Name of the database
755755
* @return database handler
756-
* @deprecated Use {@link #db(DbName)} instead
757756
*/
758-
@Deprecated
759757
default ArangoDatabase db(String name) {
760758
return db(DbName.of(name));
761759
}
@@ -765,7 +763,9 @@ default ArangoDatabase db(String name) {
765763
*
766764
* @param dbName Name of the database
767765
* @return database handler
766+
* @deprecated Use {@link #db(String)} instead
768767
*/
768+
@Deprecated
769769
ArangoDatabase db(DbName dbName);
770770

771771
/**
@@ -781,9 +781,7 @@ default ArangoDatabase db(String name) {
781781
* @throws ArangoDBException
782782
* @see <a href="https://www.arangodb.com/docs/stable/http/database-database-management.html#create-database">API
783783
* Documentation</a>
784-
* @deprecated Use {@link #createDatabase(DbName)} instead
785784
*/
786-
@Deprecated
787785
default Boolean createDatabase(String name) throws ArangoDBException {
788786
return createDatabase(DbName.of(name));
789787
}
@@ -796,7 +794,9 @@ default Boolean createDatabase(String name) throws ArangoDBException {
796794
* @throws ArangoDBException
797795
* @see <a href="https://www.arangodb.com/docs/stable/http/database-database-management.html#create-database">API
798796
* Documentation</a>
797+
* @deprecated Use {@link #createDatabase(String)} instead
799798
*/
799+
@Deprecated
800800
Boolean createDatabase(DbName dbName) throws ArangoDBException;
801801

802802
/**

‎src/main/java/com/arangodb/ArangoDatabase.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor {
5555
* Returns the name of the database
5656
*
5757
* @return database name
58-
* @deprecated Use {@link #dbName()} instead
5958
*/
60-
@Deprecated
6159
default String name() {
6260
return dbName().get();
6361
}
@@ -66,7 +64,9 @@ default String name() {
6664
* Returns the name of the database
6765
*
6866
* @return database name
67+
* @deprecated Use {@link #name()} instead
6968
*/
69+
@Deprecated
7070
DbName dbName();
7171

7272
/**

‎src/main/java/com/arangodb/DbName.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,12 @@
1313
*
1414
* @see <a href="http://https://www.arangodb.com/docs/stable/data-modeling-naming-conventions-database-names.html">
1515
* API Documentation</a>
16+
*
17+
* @deprecated This class is deprecated and will be removed in a future release. Use plain String instead.
18+
* Wrapper classes for data definition names are not required anymore, since ArangoDB throws an error if a name is
19+
* not NFC-normalized.
1620
*/
21+
@Deprecated
1722
public final class DbName implements Supplier<String> {
1823

1924
/**

‎src/main/java/com/arangodb/async/ArangoDBAsync.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,7 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor {
9696
*
9797
* @param name Name of the database
9898
* @return database handler
99-
* @deprecated Use {@link #db(DbName)} instead
10099
*/
101-
@Deprecated
102100
default ArangoDatabaseAsync db(final String name) {
103101
return db(DbName.of(name));
104102
}
@@ -108,7 +106,9 @@ default ArangoDatabaseAsync db(final String name) {
108106
*
109107
* @param dbName Name of the database
110108
* @return database handler
109+
* @deprecated Use {@link #db(String)} instead
111110
*/
111+
@Deprecated
112112
ArangoDatabaseAsync db(final DbName dbName);
113113

114114
/**
@@ -123,9 +123,7 @@ default ArangoDatabaseAsync db(final String name) {
123123
* @return true if the database was created successfully.
124124
* @see <a href="https://www.arangodb.com/docs/stable/http/database-database-management.html#create-database">API
125125
* Documentation</a>
126-
* @deprecated Use {@link #createDatabase(DbName)} instead
127126
*/
128-
@Deprecated
129127
default CompletableFuture<Boolean> createDatabase(final String name) {
130128
return createDatabase(DbName.of(name));
131129
}
@@ -137,7 +135,9 @@ default CompletableFuture<Boolean> createDatabase(final String name) {
137135
* @return true if the database was created successfully.
138136
* @see <a href="https://www.arangodb.com/docs/stable/http/database-database-management.html#create-database">API
139137
* Documentation</a>
138+
* @deprecated Use {@link #createDatabase(String)} instead
140139
*/
140+
@Deprecated
141141
CompletableFuture<Boolean> createDatabase(final DbName dbName);
142142

143143
/**

‎src/main/java/com/arangodb/async/ArangoDatabaseAsync.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor {
5858
* Returns the name of the database
5959
*
6060
* @return database name
61-
* @deprecated Use {@link #dbName()} instead
6261
*/
63-
@Deprecated
6462
default String name() {
6563
return dbName().get();
6664
}
@@ -69,7 +67,9 @@ default String name() {
6967
* Returns the name of the database
7068
*
7169
* @return database name
70+
* @deprecated Use {@link #name()} instead
7271
*/
72+
@Deprecated
7373
DbName dbName();
7474

7575
/**

‎src/main/java/com/arangodb/model/DBCreateOptions.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,17 +61,17 @@ public String getName() {
6161
/**
6262
* @param name Has to contain a valid database name
6363
* @return options
64-
* @deprecated Use {@link #name(DbName)} instead.
6564
*/
66-
@Deprecated
6765
public DBCreateOptions name(final String name) {
6866
return name(DbName.of(name));
6967
}
7068

7169
/**
7270
* @param dbName database name
7371
* @return options
72+
* @deprecated Use {@link #name(String)} instead.
7473
*/
74+
@Deprecated
7575
public DBCreateOptions name(final DbName dbName) {
7676
name = dbName.get();
7777
return this;

‎src/main/java/com/arangodb/velocystream/Request.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,14 @@ public class Request {
4242
@Expose(serialize = false)
4343
private VPackSlice body;
4444

45-
/**
46-
* @deprecated Use {@link #Request(DbName, RequestType, String)} instead
47-
*/
48-
@Deprecated
4945
public Request(final String database, final RequestType requestType, final String path) {
5046
this(DbName.of(database), requestType, path);
5147
}
5248

49+
/**
50+
* @deprecated Use {@link #Request(String, RequestType, String)} instead
51+
*/
52+
@Deprecated
5353
public Request(final DbName dbName, final RequestType requestType, final String path) {
5454
super();
5555
this.dbName = dbName;
@@ -78,14 +78,14 @@ public Request setType(final int type) {
7878
return this;
7979
}
8080

81-
/**
82-
* @deprecated Use {@link #getDbName()} instead
83-
*/
84-
@Deprecated
8581
public String getDatabase() {
8682
return getDbName().get();
8783
}
8884

85+
/**
86+
* @deprecated Use {@link #getDatabase()} instead
87+
*/
88+
@Deprecated
8989
public DbName getDbName() {
9090
return dbName;
9191
}

0 commit comments

Comments
 (0)