Skip to content

Commit 03d62b6

Browse files
committed
Add thread-safety Javadoc
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1333397 13f79535-47bb-0310-9956-ffa450edef68
1 parent 63c51ca commit 03d62b6

30 files changed

Lines changed: 84 additions & 1 deletion

src/main/java/org/apache/commons/codec/CharEncoding.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@
4747
* This perhaps would best belong in the [lang] project. Even if a similar interface is defined in [lang], it is not
4848
* foreseen that [codec] would be made to depend on [lang].
4949
*
50+
* This class is immutable and thread-safe.
51+
*
5052
* @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
5153
* @since 1.4
5254
* @version $Id$

src/main/java/org/apache/commons/codec/Charsets.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@
4949
* This perhaps would best belong in the Commons Lang project. Even if a similar class is defined in Commons Lang, it is
5050
* not foreseen that Commons Codec would be made to depend on Commons Lang.
5151
*
52+
* This class is immutable and thread-safe.
53+
*
5254
* @see <a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
5355
* @since 1.7
5456
* @version $Id: CharEncoding.java 1173287 2011-09-20 18:16:19Z ggregory $

src/main/java/org/apache/commons/codec/StringEncoderComparator.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
* Soundex, Metaphone, etc. This class can come in handy if one need to sort Strings by an encoded form of a name such
2525
* as Soundex.
2626
*
27+
* This class is immutable and thread-safe.
28+
*
2729
* @version $Id$
2830
*/
2931
public class StringEncoderComparator implements Comparator {

src/main/java/org/apache/commons/codec/binary/BinaryCodec.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525
/**
2626
* Converts between byte arrays and strings of "0"s and "1"s.
2727
*
28+
* This class is immutable and thread-safe.
29+
*
2830
* TODO: may want to add more bit vector functions like and/or/xor/nand
2931
* TODO: also might be good to generate boolean[] from byte[] et cetera.
3032
*

src/main/java/org/apache/commons/codec/binary/Hex.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131
* Converts hexadecimal Strings. The charset used for certain operation can be set, the default is set in
3232
* {@link #DEFAULT_CHARSET_NAME}
3333
*
34+
* This class is thread-safe.
35+
*
3436
* @since 1.1
3537
* @version $Id$
3638
*/

src/main/java/org/apache/commons/codec/binary/StringUtils.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727
* Converts String to and from bytes using the encodings required by the Java specification. These encodings are specified in <a
2828
* href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
2929
*
30+
* This class is immutable and thread-safe.
31+
*
3032
* @see CharEncoding
3133
* @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
3234
* @version $Id$

src/main/java/org/apache/commons/codec/digest/B64.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323
*
2424
* TODO: Can Base64 be reused?
2525
*
26+
* This class is immutable and thread-safe.
27+
*
2628
* @version $Id$
2729
* @since 1.7
2830
*/

src/main/java/org/apache/commons/codec/digest/Crypt.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323
*
2424
* See {@link #crypt(String, String)} for further details.
2525
*
26+
* This class is immutable and thread-safe.
27+
*
2628
* @version $Id$
2729
* @since 1.7
2830
*/

src/main/java/org/apache/commons/codec/digest/Md5Crypt.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@
3939
* The C style comments are from the original C code, the ones with "//" from the port.
4040
* </p>
4141
*
42+
* This class is immutable and thread-safe.
43+
*
4244
* @version $Id$
4345
* @since 1.7
4446
*/

src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@
3434
* into the Public Domain.
3535
* </p>
3636
*
37+
* This class is immutable and thread-safe.
38+
*
3739
* @version $Id$
3840
* @since 1.7
3941
*/

0 commit comments

Comments
 (0)