Skip to content

Commit fa0a4a0

Browse files
committed
Improve Javadoc for SqlLobValue
1 parent 41a6b7e commit fa0a4a0

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

spring-jdbc/src/main/java/org/springframework/jdbc/core/support/SqlLobValue.java

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2017 the original author or authors.
2+
* Copyright 2002-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -30,15 +30,15 @@
3030

3131
/**
3232
* Object to represent an SQL BLOB/CLOB value parameter. BLOBs can either be an
33-
* InputStream or a byte array. CLOBs can be in the form of a Reader, InputStream
33+
* InputStream or a byte array. CLOBs can be in the form of a Reader, InputStream,
3434
* or String. Each CLOB/BLOB value will be stored together with its length.
35-
* The type is based on which constructor is used. Objects of this class are
36-
* immutable except for the LobCreator reference. Use them and discard them.
35+
* The type is based on which constructor is used. Instances of this class are
36+
* stateful and immutable: use them and discard them.
3737
*
38-
* <p>This class holds a reference to a LocCreator that must be closed after the
39-
* update has completed. This is done via a call to the closeLobCreator method.
40-
* All handling of the LobCreator is done by the framework classes that use it -
41-
* no need to set or close the LobCreator for end users of this class.
38+
* <p>This class holds a reference to a {@link LobCreator} that must be closed after
39+
* the update has completed. This is done via a call to the {@link #cleanup()} method.
40+
* All handling of the {@code LobCreator} is done by the framework classes that use it -
41+
* no need to set or close the {@code LobCreator} for end users of this class.
4242
*
4343
* <p>A usage example:
4444
*
@@ -72,8 +72,7 @@ public class SqlLobValue implements DisposableSqlTypeValue {
7272
private final int length;
7373

7474
/**
75-
* This contains a reference to the LobCreator - so we can close it
76-
* once the update is done.
75+
* Reference to the LobCreator - so we can close it once the update is done.
7776
*/
7877
private final LobCreator lobCreator;
7978

0 commit comments

Comments
 (0)