From c90b815dabed85666621b714ff34b469851afc51 Mon Sep 17 00:00:00 2001 From: Sebastian Bazley Date: Thu, 1 Jul 2010 09:48:23 +0000 Subject: [PATCH] Document thread-safety (where known) git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@959577 13f79535-47bb-0310-9956-ffa450edef68 --- src/main/java/org/apache/commons/lang3/builder/package.html | 1 + src/main/java/org/apache/commons/lang3/concurrent/package.html | 1 + src/main/java/org/apache/commons/lang3/math/package.html | 1 + src/main/java/org/apache/commons/lang3/mutable/package.html | 1 + src/main/java/org/apache/commons/lang3/package.html | 2 ++ src/main/java/org/apache/commons/lang3/reflect/package.html | 1 + .../java/org/apache/commons/lang3/text/translate/package.html | 1 + src/main/java/org/apache/commons/lang3/time/StopWatch.java | 2 ++ src/main/java/org/apache/commons/lang3/time/package.html | 1 + 9 files changed, 11 insertions(+) diff --git a/src/main/java/org/apache/commons/lang3/builder/package.html b/src/main/java/org/apache/commons/lang3/builder/package.html index 84d29bbe9..dd40682d3 100644 --- a/src/main/java/org/apache/commons/lang3/builder/package.html +++ b/src/main/java/org/apache/commons/lang3/builder/package.html @@ -23,5 +23,6 @@ Assists in creating consistent equals(Object), toString()These classes are not thread-safe.

diff --git a/src/main/java/org/apache/commons/lang3/concurrent/package.html b/src/main/java/org/apache/commons/lang3/concurrent/package.html index 25ba693f0..0ab61e0eb 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/package.html +++ b/src/main/java/org/apache/commons/lang3/concurrent/package.html @@ -18,5 +18,6 @@ limitations under the License. Provides support classes for multi-threaded programming. This package is intended to be an extension to java.util.concurrent. +

These classes are thread-safe.

diff --git a/src/main/java/org/apache/commons/lang3/math/package.html b/src/main/java/org/apache/commons/lang3/math/package.html index 3be339c04..7f6291196 100644 --- a/src/main/java/org/apache/commons/lang3/math/package.html +++ b/src/main/java/org/apache/commons/lang3/math/package.html @@ -20,5 +20,6 @@ Extends {@link java.math} for business mathematical classes. This package is int mathematical use, not scientific use. See Commons Math for a more complete set of mathematical classes. @since 2.0 +

These classes are immutable, and therefore thread-safe.

diff --git a/src/main/java/org/apache/commons/lang3/mutable/package.html b/src/main/java/org/apache/commons/lang3/mutable/package.html index b51be2ab3..2f7436afd 100644 --- a/src/main/java/org/apache/commons/lang3/mutable/package.html +++ b/src/main/java/org/apache/commons/lang3/mutable/package.html @@ -24,5 +24,6 @@ Provides typed mutable wrappers to primitive values and Object. @since 2.1 +

These classes are not thread-safe.

diff --git a/src/main/java/org/apache/commons/lang3/package.html b/src/main/java/org/apache/commons/lang3/package.html index 78a49fd4d..1625c62dd 100644 --- a/src/main/java/org/apache/commons/lang3/package.html +++ b/src/main/java/org/apache/commons/lang3/package.html @@ -19,5 +19,7 @@ limitations under the License. Provides highly reusable static utility methods, chiefly concerned with adding value to the {@link java.lang} classes. @since 1.0 +

Most of these classes are immutable and thus thread-safe. +However Charset is not currently guaranteed thread-safe under all circumstances.

diff --git a/src/main/java/org/apache/commons/lang3/reflect/package.html b/src/main/java/org/apache/commons/lang3/reflect/package.html index 09f86bfa0..618b07a8c 100644 --- a/src/main/java/org/apache/commons/lang3/reflect/package.html +++ b/src/main/java/org/apache/commons/lang3/reflect/package.html @@ -24,5 +24,6 @@ Accumulates common high-level uses of the java.lang.reflect APIs. @since 3.0 +

These classes are immutable, and therefore thread-safe.

diff --git a/src/main/java/org/apache/commons/lang3/text/translate/package.html b/src/main/java/org/apache/commons/lang3/text/translate/package.html index 1bc86ef9a..ac0911896 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/package.html +++ b/src/main/java/org/apache/commons/lang3/text/translate/package.html @@ -22,5 +22,6 @@ building blocks. Initially created to make it possible for the user to customize the rules in the StringEscapeUtils class.

@since 3.0 +

These classes are immutable, and therefore thread-safe.

diff --git a/src/main/java/org/apache/commons/lang3/time/StopWatch.java b/src/main/java/org/apache/commons/lang3/time/StopWatch.java index e14186f89..8ddaaee5d 100644 --- a/src/main/java/org/apache/commons/lang3/time/StopWatch.java +++ b/src/main/java/org/apache/commons/lang3/time/StopWatch.java @@ -50,6 +50,8 @@ package org.apache.commons.lang3.time; * 4. start() cannot be called twice without calling reset() *

* + *

This class is not thread-safe

+ * * @author Apache Software Foundation * @since 2.0 * @version $Id$ diff --git a/src/main/java/org/apache/commons/lang3/time/package.html b/src/main/java/org/apache/commons/lang3/time/package.html index e575ca3c7..04960f215 100644 --- a/src/main/java/org/apache/commons/lang3/time/package.html +++ b/src/main/java/org/apache/commons/lang3/time/package.html @@ -18,5 +18,6 @@ limitations under the License. Provides classes and methods to work with dates and durations. @since 2.0 +

These classes are immutable (and therefore thread-safe) apart from {@link StopWatch}.