Skip to content

Commit f51dbc9

Browse files
committed
DataHandleService: document behavior when encountering null
1 parent e537ec1 commit f51dbc9

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

src/main/java/org/scijava/io/handle/DataHandleService.java

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,9 @@ default Class<Location> getType() {
7171
*
7272
* @param location the location to test
7373
* @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
7677
*/
7778
default boolean exists(final Location location) throws IOException {
7879
try (DataHandle<Location> handle = create(location)) {
@@ -85,6 +86,8 @@ default boolean exists(final Location location) throws IOException {
8586
* reading.
8687
*
8788
* @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}
8891
* @see ReadBufferDataHandle#ReadBufferDataHandle(DataHandle)
8992
*/
9093
default DataHandle<Location> readBuffer(final DataHandle<Location> handle) {
@@ -95,7 +98,10 @@ default DataHandle<Location> readBuffer(final DataHandle<Location> handle) {
9598
* Creates a {@link DataHandle} on the provided {@link Location} wrapped in a
9699
* read-only buffer for accelerated reading.
97100
*
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.
99105
* @see ReadBufferDataHandle#ReadBufferDataHandle(DataHandle)
100106
*/
101107
default DataHandle<Location> readBuffer(final Location location) {
@@ -108,6 +114,8 @@ default DataHandle<Location> readBuffer(final Location location) {
108114
* accelerated writing.
109115
*
110116
* @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}
111119
* @see WriteBufferDataHandle#WriteBufferDataHandle(DataHandle)
112120
*/
113121
default DataHandle<Location> writeBuffer(final DataHandle<Location> handle) {

0 commit comments

Comments
 (0)