@@ -71,8 +71,9 @@ default Class<Location> getType() {
71
71
*
72
72
* @param location the location to test
73
73
* @return The result of {@link DataHandle#exists()} on a newly created handle
74
- * on this location
75
- * @throws IOException
74
+ * on this location. Also returns {@code false} if the handle can not
75
+ * be created.
76
+ * @throws IOException if the creation of the handle fails exceptionally
76
77
*/
77
78
default boolean exists (final Location location ) throws IOException {
78
79
try (DataHandle <Location > handle = create (location )) {
@@ -85,6 +86,8 @@ default boolean exists(final Location location) throws IOException {
85
86
* reading.
86
87
*
87
88
* @param handle the handle to wrap
89
+ * @return The handle wrapped in a read-only buffer, or {@code null} if the
90
+ * input handle is {@code null}
88
91
* @see ReadBufferDataHandle#ReadBufferDataHandle(DataHandle)
89
92
*/
90
93
default DataHandle <Location > readBuffer (final DataHandle <Location > handle ) {
@@ -95,7 +98,10 @@ default DataHandle<Location> readBuffer(final DataHandle<Location> handle) {
95
98
* Creates a {@link DataHandle} on the provided {@link Location} wrapped in a
96
99
* read-only buffer for accelerated reading.
97
100
*
98
- * @param location the handle to wrap
101
+ * @param location the Location to create a buffered handle on.
102
+ * @return A {@link DataHandle} on the provided location wrapped in a
103
+ * read-only buffer, or {@code null} if no handle could be created for
104
+ * the location.
99
105
* @see ReadBufferDataHandle#ReadBufferDataHandle(DataHandle)
100
106
*/
101
107
default DataHandle <Location > readBuffer (final Location location ) {
@@ -108,6 +114,8 @@ default DataHandle<Location> readBuffer(final Location location) {
108
114
* accelerated writing.
109
115
*
110
116
* @param handle the handle to wrap
117
+ * @return the handle wrapped in a write-only buffer or {@code null} if the
118
+ * provided handle is {@code null}
111
119
* @see WriteBufferDataHandle#WriteBufferDataHandle(DataHandle)
112
120
*/
113
121
default DataHandle <Location > writeBuffer (final DataHandle <Location > handle ) {
0 commit comments