Skip to content

Commit 2d72d77

Browse files
committed
Javadoc cleanup to reduce missing links to hidden classes
1 parent b1665b9 commit 2d72d77

File tree

7 files changed

+31
-18
lines changed

7 files changed

+31
-18
lines changed

driver/src/main/java/oracle/nosql/driver/iam/InstancePrincipalsProvider.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@ public InstancePrincipalsProvider(SecurityTokenSupplier tokenSupplier,
6666
this.region = region;
6767
}
6868

69+
/**
70+
* @hidden
71+
*/
6972
public void prepare(NoSQLHandleConfig config) {
7073
tokenSupplier.prepare(config);
7174
}

driver/src/main/java/oracle/nosql/driver/ops/DurableRequest.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010
import oracle.nosql.driver.Durability;
1111

1212
/**
13-
* @hidden
14-
*
1513
* Represents a base class for operations that support a
1614
* {@link Durability} setting.
1715
*/

driver/src/main/java/oracle/nosql/driver/ops/GetIndexesRequest.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,11 +113,17 @@ public void validate() {
113113
}
114114
}
115115

116+
/**
117+
* @hidden
118+
*/
116119
@Override
117120
public Serializer createSerializer(SerializerFactory factory) {
118121
return factory.createGetIndexesSerializer();
119122
}
120123

124+
/**
125+
* @hidden
126+
*/
121127
@Override
122128
public Serializer createDeserializer(SerializerFactory factory) {
123129
return factory.createGetIndexesDeserializer();

driver/src/main/java/oracle/nosql/driver/ops/ReadRequest.java

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,25 @@
1212
import oracle.nosql.driver.NoSQLHandleConfig;
1313

1414
/**
15-
* @hidden
16-
*
1715
* Represents a base class for read operations such as
1816
* {@link NoSQLHandle#get}.
19-
* <p>
20-
* This class encapsulates the common parameters of table name and
21-
* {@link Consistency}. By default read operations use
22-
* {@link Consistency#EVENTUAL}. Use of {@link Consistency#ABSOLUTE} should
23-
* be used only when required as it incurs additional cost.
2417
*/
2518
public abstract class ReadRequest extends Request {
2619

2720
private Consistency consistency;
2821

2922
protected ReadRequest() {}
3023

24+
/**
25+
* @hidden
26+
*/
3127
public Consistency getConsistencyInternal() {
3228
return consistency;
3329
}
3430

31+
/**
32+
* @hidden
33+
*/
3534
protected void setConsistencyInternal(Consistency consistency) {
3635
this.consistency = consistency;
3736
}

driver/src/main/java/oracle/nosql/driver/ops/WriteRequest.java

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,8 @@
1111
import oracle.nosql.driver.NoSQLHandleConfig;
1212

1313
/**
14-
* @hidden
15-
*
1614
* Represents a base class for the single row modifying operations
1715
* {@link NoSQLHandle#put} and {@link NoSQLHandle#delete}.
18-
* <p>
19-
* This class encapsulates the common parameters of table name and
20-
* the return row boolean, which allows applications to get information
21-
* about the existing value of the target row on failure. By default
22-
* no previous information is returned.
2316
*/
2417
public abstract class WriteRequest extends DurableRequest {
2518

driver/src/main/java/oracle/nosql/driver/ops/WriteResult.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
import oracle.nosql.driver.http.Client;
1313

1414
/**
15-
* @hidden
16-
*
1715
* A base class for results of single row modifying operations such as put
1816
* and delete.
1917
*/

driver/src/main/java/oracle/nosql/driver/values/EmptyValue.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,16 @@ private EmptyValue() {
2727
super();
2828
}
2929

30+
/**
31+
* @hidden
32+
*/
3033
@Override
3134
public Type getType() {
3235
return Type.EMPTY;
3336
}
3437

3538
/**
39+
* @hidden
3640
* Returns an instance (singleton) of EmptyValue.
3741
*
3842
* @return the value
@@ -41,6 +45,9 @@ public static EmptyValue getInstance() {
4145
return INSTANCE;
4246
}
4347

48+
/**
49+
* @hidden
50+
*/
4451
@Override
4552
public int compareTo(FieldValue other) {
4653
if (other instanceof EmptyValue) {
@@ -50,16 +57,25 @@ public int compareTo(FieldValue other) {
5057
return -1;
5158
}
5259

60+
/**
61+
* @hidden
62+
*/
5363
@Override
5464
public String toJson(JsonOptions options) {
5565
return "\"EMPTY\"";
5666
}
5767

68+
/**
69+
* @hidden
70+
*/
5871
@Override
5972
public boolean equals(Object other) {
6073
return other == INSTANCE;
6174
}
6275

76+
/**
77+
* @hidden
78+
*/
6379
@Override
6480
public int hashCode() {
6581
return super.hashCode();

0 commit comments

Comments
 (0)