You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by sc...@apache.org on 2011/03/04 17:07:14 UTC
svn commit: r1078032 [5/5] - in
/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3: ./
builder/
Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/SystemUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/SystemUtils.java?rev=1078032&r1=1078031&r2=1078032&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/SystemUtils.java (original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/SystemUtils.java Fri Mar 4 16:07:14 2011
@@ -20,12 +20,12 @@ import java.io.File;
/**
* <p>
- * Helpers for <code>java.lang.System</code>.
+ * Helpers for {@code java.lang.System}.
* </p>
*
* <p>
- * If a system property cannot be read due to security restrictions, the corresponding field in this class will be set to <code>null</code>
- * and a message will be written to <code>System.err</code>.
+ * If a system property cannot be read due to security restrictions, the corresponding field in this class will be set to {@code null}
+ * and a message will be written to {@code System.err}.
* </p>
*
* <p>
@@ -77,17 +77,17 @@ public class SystemUtils {
/**
* <p>
- * The <code>awt.toolkit</code> System Property.
+ * The {@code awt.toolkit} System Property.
* </p>
* <p>
- * Holds a class name, on Windows XP this is <code>sun.awt.windows.WToolkit</code>.
+ * Holds a class name, on Windows XP this is {@code sun.awt.windows.WToolkit}.
* </p>
* <p>
- * <b>On platforms without a GUI, this value is <code>null</code>.</b>
+ * <b>On platforms without a GUI, this value is {@code null}.</b>
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -102,14 +102,14 @@ public class SystemUtils {
/**
* <p>
- * The <code>file.encoding</code> System Property.
+ * The {@code file.encoding} System Property.
* </p>
* <p>
- * File encoding, such as <code>Cp1252</code>.
+ * File encoding, such as {@code Cp1252}.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -125,11 +125,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>file.separator</code> System Property. File separator (<code>"/"</code> on UNIX).
+ * The {@code file.separator} System Property. File separator (<code>"/"</code> on UNIX).
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -144,11 +144,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.awt.fonts</code> System Property.
+ * The {@code java.awt.fonts} System Property.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -163,11 +163,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.awt.graphicsenv</code> System Property.
+ * The {@code java.awt.graphicsenv} System Property.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -182,12 +182,12 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.awt.headless</code> System Property. The value of this property is the String <code>"true"</code> or
- * <code>"false"</code>.
+ * The {@code java.awt.headless} System Property. The value of this property is the String {@code "true"} or
+ * {@code "false"}.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -204,11 +204,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.awt.printerjob</code> System Property.
+ * The {@code java.awt.printerjob} System Property.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -223,11 +223,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.class.path</code> System Property. Java class path.
+ * The {@code java.class.path} System Property. Java class path.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -242,11 +242,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.class.version</code> System Property. Java class format version number.
+ * The {@code java.class.version} System Property. Java class format version number.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -261,12 +261,12 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.compiler</code> System Property. Name of JIT compiler to use. First in JDK version 1.2. Not used in Sun JDKs after
+ * The {@code java.compiler} System Property. Name of JIT compiler to use. First in JDK version 1.2. Not used in Sun JDKs after
* 1.2.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -281,11 +281,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.endorsed.dirs</code> System Property. Path of endorsed directory or directories.
+ * The {@code java.endorsed.dirs} System Property. Path of endorsed directory or directories.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -300,11 +300,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.ext.dirs</code> System Property. Path of extension directory or directories.
+ * The {@code java.ext.dirs} System Property. Path of extension directory or directories.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -319,11 +319,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.home</code> System Property. Java installation directory.
+ * The {@code java.home} System Property. Java installation directory.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -338,11 +338,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.io.tmpdir</code> System Property. Default temp file path.
+ * The {@code java.io.tmpdir} System Property. Default temp file path.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -357,11 +357,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.library.path</code> System Property. List of paths to search when loading libraries.
+ * The {@code java.library.path} System Property. List of paths to search when loading libraries.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -376,11 +376,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.runtime.name</code> System Property. Java Runtime Environment name.
+ * The {@code java.runtime.name} System Property. Java Runtime Environment name.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -396,11 +396,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.runtime.version</code> System Property. Java Runtime Environment version.
+ * The {@code java.runtime.version} System Property. Java Runtime Environment version.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -416,11 +416,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.specification.name</code> System Property. Java Runtime Environment specification name.
+ * The {@code java.specification.name} System Property. Java Runtime Environment specification name.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -435,11 +435,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.specification.vendor</code> System Property. Java Runtime Environment specification vendor.
+ * The {@code java.specification.vendor} System Property. Java Runtime Environment specification vendor.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -454,11 +454,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.specification.version</code> System Property. Java Runtime Environment specification version.
+ * The {@code java.specification.version} System Property. Java Runtime Environment specification version.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -474,11 +474,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.util.prefs.PreferencesFactory</code> System Property. A class name.
+ * The {@code java.util.prefs.PreferencesFactory} System Property. A class name.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -494,11 +494,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.vendor</code> System Property. Java vendor-specific string.
+ * The {@code java.vendor} System Property. Java vendor-specific string.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -513,11 +513,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.vendor.url</code> System Property. Java vendor URL.
+ * The {@code java.vendor.url} System Property. Java vendor URL.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -532,11 +532,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.version</code> System Property. Java version number.
+ * The {@code java.version} System Property. Java version number.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -551,11 +551,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.vm.info</code> System Property. Java Virtual Machine implementation info.
+ * The {@code java.vm.info} System Property. Java Virtual Machine implementation info.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -571,11 +571,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.vm.name</code> System Property. Java Virtual Machine implementation name.
+ * The {@code java.vm.name} System Property. Java Virtual Machine implementation name.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -590,11 +590,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.vm.specification.name</code> System Property. Java Virtual Machine specification name.
+ * The {@code java.vm.specification.name} System Property. Java Virtual Machine specification name.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -609,11 +609,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.vm.specification.vendor</code> System Property. Java Virtual Machine specification vendor.
+ * The {@code java.vm.specification.vendor} System Property. Java Virtual Machine specification vendor.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -628,11 +628,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.vm.specification.version</code> System Property. Java Virtual Machine specification version.
+ * The {@code java.vm.specification.version} System Property. Java Virtual Machine specification version.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -647,11 +647,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.vm.vendor</code> System Property. Java Virtual Machine implementation vendor.
+ * The {@code java.vm.vendor} System Property. Java Virtual Machine implementation vendor.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -666,11 +666,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>java.vm.version</code> System Property. Java Virtual Machine implementation version.
+ * The {@code java.vm.version} System Property. Java Virtual Machine implementation version.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -685,11 +685,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>line.separator</code> System Property. Line separator (<code>"\n"</code> on UNIX).
+ * The {@code line.separator} System Property. Line separator (<code>"\n"</code> on UNIX).
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -704,11 +704,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>os.arch</code> System Property. Operating system architecture.
+ * The {@code os.arch} System Property. Operating system architecture.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -723,11 +723,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>os.name</code> System Property. Operating system name.
+ * The {@code os.name} System Property. Operating system name.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -742,11 +742,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>os.version</code> System Property. Operating system version.
+ * The {@code os.version} System Property. Operating system version.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -761,11 +761,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>path.separator</code> System Property. Path separator (<code>":"</code> on UNIX).
+ * The {@code path.separator} System Property. Path separator (<code>":"</code> on UNIX).
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -780,12 +780,12 @@ public class SystemUtils {
/**
* <p>
- * The <code>user.country</code> or <code>user.region</code> System Property. User's country code, such as <code>GB</code>. First in
- * Java version 1.2 as <code>user.region</code>. Renamed to <code>user.country</code> in 1.4
+ * The {@code user.country} or {@code user.region} System Property. User's country code, such as {@code GB}. First in
+ * Java version 1.2 as {@code user.region}. Renamed to {@code user.country} in 1.4
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -802,11 +802,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>user.dir</code> System Property. User's current working directory.
+ * The {@code user.dir} System Property. User's current working directory.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -821,11 +821,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>user.home</code> System Property. User's home directory.
+ * The {@code user.home} System Property. User's home directory.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -840,11 +840,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>user.language</code> System Property. User's language code, such as <code>"en"</code>.
+ * The {@code user.language} System Property. User's language code, such as {@code "en"}.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -860,11 +860,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>user.name</code> System Property. User's account name.
+ * The {@code user.name} System Property. User's account name.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -879,11 +879,11 @@ public class SystemUtils {
/**
* <p>
- * The <code>user.timezone</code> System Property. For example: <code>"America/Los_Angeles"</code>.
+ * The {@code user.timezone} System Property. For example: {@code "America/Los_Angeles"}.
* </p>
*
* <p>
- * Defaults to <code>null</code> if the runtime does not have security access to read this property or the property does not exist.
+ * Defaults to {@code null} if the runtime does not have security access to read this property or the property does not exist.
* </p>
*
* <p>
@@ -903,77 +903,77 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is Java version 1.1 (also 1.1.x versions).
+ * Is {@code true} if this is Java version 1.1 (also 1.1.x versions).
* </p>
*
* <p>
- * The field will return <code>false</code> if {@link #JAVA_VERSION} is <code>null</code>.
+ * The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}.
* </p>
*/
public static final boolean IS_JAVA_1_1 = getJavaVersionMatches("1.1");
/**
* <p>
- * Is <code>true</code> if this is Java version 1.2 (also 1.2.x versions).
+ * Is {@code true} if this is Java version 1.2 (also 1.2.x versions).
* </p>
*
* <p>
- * The field will return <code>false</code> if {@link #JAVA_VERSION} is <code>null</code>.
+ * The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}.
* </p>
*/
public static final boolean IS_JAVA_1_2 = getJavaVersionMatches("1.2");
/**
* <p>
- * Is <code>true</code> if this is Java version 1.3 (also 1.3.x versions).
+ * Is {@code true} if this is Java version 1.3 (also 1.3.x versions).
* </p>
*
* <p>
- * The field will return <code>false</code> if {@link #JAVA_VERSION} is <code>null</code>.
+ * The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}.
* </p>
*/
public static final boolean IS_JAVA_1_3 = getJavaVersionMatches("1.3");
/**
* <p>
- * Is <code>true</code> if this is Java version 1.4 (also 1.4.x versions).
+ * Is {@code true} if this is Java version 1.4 (also 1.4.x versions).
* </p>
*
* <p>
- * The field will return <code>false</code> if {@link #JAVA_VERSION} is <code>null</code>.
+ * The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}.
* </p>
*/
public static final boolean IS_JAVA_1_4 = getJavaVersionMatches("1.4");
/**
* <p>
- * Is <code>true</code> if this is Java version 1.5 (also 1.5.x versions).
+ * Is {@code true} if this is Java version 1.5 (also 1.5.x versions).
* </p>
*
* <p>
- * The field will return <code>false</code> if {@link #JAVA_VERSION} is <code>null</code>.
+ * The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}.
* </p>
*/
public static final boolean IS_JAVA_1_5 = getJavaVersionMatches("1.5");
/**
* <p>
- * Is <code>true</code> if this is Java version 1.6 (also 1.6.x versions).
+ * Is {@code true} if this is Java version 1.6 (also 1.6.x versions).
* </p>
*
* <p>
- * The field will return <code>false</code> if {@link #JAVA_VERSION} is <code>null</code>.
+ * The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}.
* </p>
*/
public static final boolean IS_JAVA_1_6 = getJavaVersionMatches("1.6");
/**
* <p>
- * Is <code>true</code> if this is Java version 1.7 (also 1.7.x versions).
+ * Is {@code true} if this is Java version 1.7 (also 1.7.x versions).
* </p>
*
* <p>
- * The field will return <code>false</code> if {@link #JAVA_VERSION} is <code>null</code>.
+ * The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}.
* </p>
*
* @since 3.0
@@ -990,11 +990,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is AIX.
+ * Is {@code true} if this is AIX.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1003,11 +1003,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is HP-UX.
+ * Is {@code true} if this is HP-UX.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1016,11 +1016,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is Irix.
+ * Is {@code true} if this is Irix.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1029,11 +1029,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is Linux.
+ * Is {@code true} if this is Linux.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1042,11 +1042,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is Mac.
+ * Is {@code true} if this is Mac.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1055,11 +1055,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is Mac.
+ * Is {@code true} if this is Mac.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1068,11 +1068,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is OS/2.
+ * Is {@code true} if this is OS/2.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1081,11 +1081,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is Solaris.
+ * Is {@code true} if this is Solaris.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1094,11 +1094,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is SunOS.
+ * Is {@code true} if this is SunOS.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1107,11 +1107,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is a UNIX like system, as in any of AIX, HP-UX, Irix, Linux, MacOSX, Solaris or SUN OS.
+ * Is {@code true} if this is a UNIX like system, as in any of AIX, HP-UX, Irix, Linux, MacOSX, Solaris or SUN OS.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.1
@@ -1121,11 +1121,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is Windows.
+ * Is {@code true} if this is Windows.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1134,11 +1134,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is Windows 2000.
+ * Is {@code true} if this is Windows 2000.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1147,11 +1147,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is Windows 95.
+ * Is {@code true} if this is Windows 95.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1161,11 +1161,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is Windows 98.
+ * Is {@code true} if this is Windows 98.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1175,11 +1175,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is Windows ME.
+ * Is {@code true} if this is Windows ME.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1189,11 +1189,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is Windows NT.
+ * Is {@code true} if this is Windows NT.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1203,11 +1203,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is Windows XP.
+ * Is {@code true} if this is Windows XP.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.0
@@ -1217,11 +1217,11 @@ public class SystemUtils {
// -----------------------------------------------------------------------
/**
* <p>
- * Is <code>true</code> if this is Windows Vista.
+ * Is {@code true} if this is Windows Vista.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 2.4
@@ -1230,11 +1230,11 @@ public class SystemUtils {
/**
* <p>
- * Is <code>true</code> if this is Windows 7.
+ * Is {@code true} if this is Windows 7.
* </p>
*
* <p>
- * The field will return <code>false</code> if <code>OS_NAME</code> is <code>null</code>.
+ * The field will return {@code false} if {@code OS_NAME} is {@code null}.
* </p>
*
* @since 3.0
@@ -1243,12 +1243,12 @@ public class SystemUtils {
/**
* <p>
- * Gets the Java home directory as a <code>File</code>.
+ * Gets the Java home directory as a {@code File}.
* </p>
*
* @return a directory
* @throws SecurityException
- * if a security manager exists and its <code>checkPropertyAccess</code> method doesn't allow access to the specified system
+ * if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system
* property.
* @see System#getProperty(String)
* @since 2.1
@@ -1259,12 +1259,12 @@ public class SystemUtils {
/**
* <p>
- * Gets the Java IO temporary directory as a <code>File</code>.
+ * Gets the Java IO temporary directory as a {@code File}.
* </p>
*
* @return a directory
* @throws SecurityException
- * if a security manager exists and its <code>checkPropertyAccess</code> method doesn't allow access to the specified system
+ * if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system
* property.
* @see System#getProperty(String)
* @since 2.1
@@ -1313,17 +1313,17 @@ public class SystemUtils {
// -----------------------------------------------------------------------
/**
* <p>
- * Gets a System property, defaulting to <code>null</code> if the property cannot be read.
+ * Gets a System property, defaulting to {@code null} if the property cannot be read.
* </p>
*
* <p>
- * If a <code>SecurityException</code> is caught, the return value is <code>null</code> and a message is written to
- * <code>System.err</code>.
+ * If a {@code SecurityException} is caught, the return value is {@code null} and a message is written to
+ * {@code System.err}.
* </p>
*
* @param property
* the system property name
- * @return the system property value or <code>null</code> if a security problem occurs
+ * @return the system property value or {@code null} if a security problem occurs
*/
private static String getSystemProperty(String property) {
try {
@@ -1338,12 +1338,12 @@ public class SystemUtils {
/**
* <p>
- * Gets the user directory as a <code>File</code>.
+ * Gets the user directory as a {@code File}.
* </p>
*
* @return a directory
* @throws SecurityException
- * if a security manager exists and its <code>checkPropertyAccess</code> method doesn't allow access to the specified system
+ * if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system
* property.
* @see System#getProperty(String)
* @since 2.1
@@ -1354,12 +1354,12 @@ public class SystemUtils {
/**
* <p>
- * Gets the user home directory as a <code>File</code>.
+ * Gets the user home directory as a {@code File}.
* </p>
*
* @return a directory
* @throws SecurityException
- * if a security manager exists and its <code>checkPropertyAccess</code> method doesn't allow access to the specified system
+ * if a security manager exists and its {@code checkPropertyAccess} method doesn't allow access to the specified system
* property.
* @see System#getProperty(String)
* @since 2.1
@@ -1369,9 +1369,9 @@ public class SystemUtils {
}
/**
- * Returns whether the {@link #JAVA_AWT_HEADLESS} value is <code>true</code>.
+ * Returns whether the {@link #JAVA_AWT_HEADLESS} value is {@code true}.
*
- * @return <code>true</code> if <code>JAVA_AWT_HEADLESS</code> is <code>"true"</code>, <code>false</code> otherwise.
+ * @return {@code true} if {@code JAVA_AWT_HEADLESS} is {@code "true"}, {@code false} otherwise.
*
* @see #JAVA_AWT_HEADLESS
* @since 2.1
@@ -1390,13 +1390,13 @@ public class SystemUtils {
* Example input:
* </p>
* <ul>
- * <li><code>1.2f</code> to test for Java 1.2</li>
- * <li><code>1.31f</code> to test for Java 1.3.1</li>
+ * <li>{@code 1.2f} to test for Java 1.2</li>
+ * <li>{@code 1.31f} to test for Java 1.3.1</li>
* </ul>
*
* @param requiredVersion
* the required version, for example 1.31f
- * @return <code>true</code> if the actual version is equal or greater than the required version
+ * @return {@code true} if the actual version is equal or greater than the required version
*/
public static boolean isJavaVersionAtLeast(JavaVersion requiredVersion) {
return JAVA_SPECIFICATION_VERSION_AS_ENUM.atLeast(requiredVersion);
@@ -1469,7 +1469,7 @@ public class SystemUtils {
/**
* <p>
* SystemUtils instances should NOT be constructed in standard programming. Instead, the class should be used as
- * <code>SystemUtils.FILE_SEPARATOR</code>.
+ * {@code SystemUtils.FILE_SEPARATOR}.
* </p>
*
* <p>
Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Validate.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Validate.java?rev=1078032&r1=1078031&r2=1078032&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Validate.java (original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Validate.java Fri Mar 4 16:07:14 2011
@@ -25,8 +25,8 @@ import java.util.regex.Pattern;
* <p>This class assists in validating arguments. The validation methods are
* based along the following principles:
* <ul>
- * <li>An invalid <code>null</code> argument causes a {@link NullPointerException}.</li>
- * <li>A non-<code>null</code> argument causes an {@link IllegalArgumentException}.</li>
+ * <li>An invalid {@code null} argument causes a {@link NullPointerException}.</li>
+ * <li>A non-{@code null} argument causes an {@link IllegalArgumentException}.</li>
* <li>An invalid index into an array/collection/map/string causes an {@link IndexOutOfBoundsException}.</li>
* </ul>
*
@@ -80,7 +80,7 @@ public class Validate {
//---------------------------------------------------------------------------------
/**
- * <p>Validate that the argument condition is <code>true</code>; otherwise
+ * <p>Validate that the argument condition is {@code true}; otherwise
* throwing an exception with the specified message. This method is useful when
* validating according to an arbitrary boolean expression, such as validating a
* primitive number or using your own custom validation expression.</p>
@@ -93,7 +93,7 @@ public class Validate {
* @param expression the boolean expression to check
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param value the value to append to the message when invalid
- * @throws IllegalArgumentException if expression is <code>false</code>
+ * @throws IllegalArgumentException if expression is {@code false}
* @see #isTrue(boolean)
* @see #isTrue(boolean, String, double)
* @see #isTrue(boolean, String, Object...)
@@ -105,7 +105,7 @@ public class Validate {
}
/**
- * <p>Validate that the argument condition is <code>true</code>; otherwise
+ * <p>Validate that the argument condition is {@code true}; otherwise
* throwing an exception with the specified message. This method is useful when
* validating according to an arbitrary boolean expression, such as validating a
* primitive number or using your own custom validation expression.</p>
@@ -118,7 +118,7 @@ public class Validate {
* @param expression the boolean expression to check
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param value the value to append to the message when invalid
- * @throws IllegalArgumentException if expression is <code>false</code>
+ * @throws IllegalArgumentException if expression is {@code false}
* @see #isTrue(boolean)
* @see #isTrue(boolean, String, long)
* @see #isTrue(boolean, String, Object...)
@@ -130,7 +130,7 @@ public class Validate {
}
/**
- * <p>Validate that the argument condition is <code>true</code>; otherwise
+ * <p>Validate that the argument condition is {@code true}; otherwise
* throwing an exception with the specified message. This method is useful when
* validating according to an arbitrary boolean expression, such as validating a
* primitive number or using your own custom validation expression.</p>
@@ -142,7 +142,7 @@ public class Validate {
* @param expression the boolean expression to check
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param values the optional values for the formatted exception message, null array not recommended
- * @throws IllegalArgumentException if expression is <code>false</code>
+ * @throws IllegalArgumentException if expression is {@code false}
* @see #isTrue(boolean)
* @see #isTrue(boolean, String, long)
* @see #isTrue(boolean, String, double)
@@ -154,7 +154,7 @@ public class Validate {
}
/**
- * <p>Validate that the argument condition is <code>true</code>; otherwise
+ * <p>Validate that the argument condition is {@code true}; otherwise
* throwing an exception. This method is useful when validating according
* to an arbitrary boolean expression, such as validating a
* primitive number or using your own custom validation expression.</p>
@@ -167,7 +167,7 @@ public class Validate {
* false".</p>
*
* @param expression the boolean expression to check
- * @throws IllegalArgumentException if expression is <code>false</code>
+ * @throws IllegalArgumentException if expression is {@code false}
* @see #isTrue(boolean, String, long)
* @see #isTrue(boolean, String, double)
* @see #isTrue(boolean, String, Object...)
@@ -182,7 +182,7 @@ public class Validate {
//---------------------------------------------------------------------------------
/**
- * <p>Validate that the specified argument is not <code>null</code>;
+ * <p>Validate that the specified argument is not {@code null};
* otherwise throwing an exception.
*
* <pre>Validate.notNull(myObject, "The object must not be null");</pre>
@@ -192,8 +192,8 @@ public class Validate {
*
* @param <T> the object type
* @param object the object to check
- * @return the validated object (never <code>null</code> for method chaining)
- * @throws NullPointerException if the object is <code>null</code>
+ * @return the validated object (never {@code null} for method chaining)
+ * @throws NullPointerException if the object is {@code null}
* @see #notNull(Object, String, Object...)
*/
public static <T> T notNull(T object) {
@@ -201,7 +201,7 @@ public class Validate {
}
/**
- * <p>Validate that the specified argument is not <code>null</code>;
+ * <p>Validate that the specified argument is not {@code null};
* otherwise throwing an exception with the specified message.
*
* <pre>Validate.notNull(myObject, "The object must not be null");</pre>
@@ -210,8 +210,8 @@ public class Validate {
* @param object the object to check
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param values the optional values for the formatted exception message
- * @return the validated object (never <code>null</code> for method chaining)
- * @throws NullPointerException if the object is <code>null</code>
+ * @return the validated object (never {@code null} for method chaining)
+ * @throws NullPointerException if the object is {@code null}
* @see #notNull(Object)
*/
public static <T> T notNull(T object, String message, Object... values) {
@@ -225,7 +225,7 @@ public class Validate {
//---------------------------------------------------------------------------------
/**
- * <p>Validate that the specified argument array is neither <code>null</code>
+ * <p>Validate that the specified argument array is neither {@code null}
* nor a length of zero (no elements); otherwise throwing an exception
* with the specified message.
*
@@ -235,8 +235,8 @@ public class Validate {
* @param array the array to check, validated not null by this method
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param values the optional values for the formatted exception message, null array not recommended
- * @return the validated array (never <code>null</code> method for chaining)
- * @throws NullPointerException if the array is <code>null</code>
+ * @return the validated array (never {@code null} method for chaining)
+ * @throws NullPointerException if the array is {@code null}
* @throws IllegalArgumentException if the array is empty
* @see #notEmpty(Object[])
*/
@@ -251,7 +251,7 @@ public class Validate {
}
/**
- * <p>Validate that the specified argument array is neither <code>null</code>
+ * <p>Validate that the specified argument array is neither {@code null}
* nor a length of zero (no elements); otherwise throwing an exception.
*
* <pre>Validate.notEmpty(myArray);</pre>
@@ -261,8 +261,8 @@ public class Validate {
*
* @param <T> the array type
* @param array the array to check, validated not null by this method
- * @return the validated array (never <code>null</code> method for chaining)
- * @throws NullPointerException if the array is <code>null</code>
+ * @return the validated array (never {@code null} method for chaining)
+ * @throws NullPointerException if the array is {@code null}
* @throws IllegalArgumentException if the array is empty
* @see #notEmpty(Object[], String, Object...)
*/
@@ -274,7 +274,7 @@ public class Validate {
//---------------------------------------------------------------------------------
/**
- * <p>Validate that the specified argument collection is neither <code>null</code>
+ * <p>Validate that the specified argument collection is neither {@code null}
* nor a size of zero (no elements); otherwise throwing an exception
* with the specified message.
*
@@ -284,8 +284,8 @@ public class Validate {
* @param collection the collection to check, validated not null by this method
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param values the optional values for the formatted exception message, null array not recommended
- * @return the validated collection (never <code>null</code> method for chaining)
- * @throws NullPointerException if the collection is <code>null</code>
+ * @return the validated collection (never {@code null} method for chaining)
+ * @throws NullPointerException if the collection is {@code null}
* @throws IllegalArgumentException if the collection is empty
* @see #notEmpty(Object[])
*/
@@ -300,7 +300,7 @@ public class Validate {
}
/**
- * <p>Validate that the specified argument collection is neither <code>null</code>
+ * <p>Validate that the specified argument collection is neither {@code null}
* nor a size of zero (no elements); otherwise throwing an exception.
*
* <pre>Validate.notEmpty(myCollection);</pre>
@@ -310,8 +310,8 @@ public class Validate {
*
* @param <T> the collection type
* @param collection the collection to check, validated not null by this method
- * @return the validated collection (never <code>null</code> method for chaining)
- * @throws NullPointerException if the collection is <code>null</code>
+ * @return the validated collection (never {@code null} method for chaining)
+ * @throws NullPointerException if the collection is {@code null}
* @throws IllegalArgumentException if the collection is empty
* @see #notEmpty(Collection, String, Object...)
*/
@@ -323,7 +323,7 @@ public class Validate {
//---------------------------------------------------------------------------------
/**
- * <p>Validate that the specified argument map is neither <code>null</code>
+ * <p>Validate that the specified argument map is neither {@code null}
* nor a size of zero (no elements); otherwise throwing an exception
* with the specified message.
*
@@ -333,8 +333,8 @@ public class Validate {
* @param map the map to check, validated not null by this method
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param values the optional values for the formatted exception message, null array not recommended
- * @return the validated map (never <code>null</code> method for chaining)
- * @throws NullPointerException if the map is <code>null</code>
+ * @return the validated map (never {@code null} method for chaining)
+ * @throws NullPointerException if the map is {@code null}
* @throws IllegalArgumentException if the map is empty
* @see #notEmpty(Object[])
*/
@@ -349,7 +349,7 @@ public class Validate {
}
/**
- * <p>Validate that the specified argument map is neither <code>null</code>
+ * <p>Validate that the specified argument map is neither {@code null}
* nor a size of zero (no elements); otherwise throwing an exception.
*
* <pre>Validate.notEmpty(myMap);</pre>
@@ -359,8 +359,8 @@ public class Validate {
*
* @param <T> the map type
* @param map the map to check, validated not null by this method
- * @return the validated map (never <code>null</code> method for chaining)
- * @throws NullPointerException if the map is <code>null</code>
+ * @return the validated map (never {@code null} method for chaining)
+ * @throws NullPointerException if the map is {@code null}
* @throws IllegalArgumentException if the map is empty
* @see #notEmpty(Map, String, Object...)
*/
@@ -373,7 +373,7 @@ public class Validate {
/**
* <p>Validate that the specified argument character sequence is
- * neither <code>null</code> nor a length of zero (no characters);
+ * neither {@code null} nor a length of zero (no characters);
* otherwise throwing an exception with the specified message.
*
* <pre>Validate.notEmpty(myString, "The string must not be empty");</pre>
@@ -382,8 +382,8 @@ public class Validate {
* @param chars the character sequence to check, validated not null by this method
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param values the optional values for the formatted exception message, null array not recommended
- * @return the validated character sequence (never <code>null</code> method for chaining)
- * @throws NullPointerException if the character sequence is <code>null</code>
+ * @return the validated character sequence (never {@code null} method for chaining)
+ * @throws NullPointerException if the character sequence is {@code null}
* @throws IllegalArgumentException if the character sequence is empty
* @see #notEmpty(CharSequence)
*/
@@ -399,7 +399,7 @@ public class Validate {
/**
* <p>Validate that the specified argument character sequence is
- * neither <code>null</code> nor a length of zero (no characters);
+ * neither {@code null} nor a length of zero (no characters);
* otherwise throwing an exception with the specified message.
*
* <pre>Validate.notEmpty(myString);</pre>
@@ -409,8 +409,8 @@ public class Validate {
*
* @param <T> the character sequence type
* @param chars the character sequence to check, validated not null by this method
- * @return the validated character sequence (never <code>null</code> method for chaining)
- * @throws NullPointerException if the character sequence is <code>null</code>
+ * @return the validated character sequence (never {@code null} method for chaining)
+ * @throws NullPointerException if the character sequence is {@code null}
* @throws IllegalArgumentException if the character sequence is empty
* @see #notEmpty(CharSequence, String, Object...)
*/
@@ -423,7 +423,7 @@ public class Validate {
/**
* <p>Validate that the specified argument character sequence is
- * neither <code>null</code>, a length of zero (no characters), empty
+ * neither {@code null}, a length of zero (no characters), empty
* nor whitespace; otherwise throwing an exception with the specified
* message.
*
@@ -433,8 +433,8 @@ public class Validate {
* @param chars the character sequence to check, validated not null by this method
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param values the optional values for the formatted exception message, null array not recommended
- * @return the validated character sequence (never <code>null</code> method for chaining)
- * @throws NullPointerException if the character sequence is <code>null</code>
+ * @return the validated character sequence (never {@code null} method for chaining)
+ * @throws NullPointerException if the character sequence is {@code null}
* @throws IllegalArgumentException if the character sequence is blank
* @see #notBlank(CharSequence)
*/
@@ -450,7 +450,7 @@ public class Validate {
/**
* <p>Validate that the specified argument character sequence is
- * neither <code>null</code>, a length of zero (no characters), empty
+ * neither {@code null}, a length of zero (no characters), empty
* nor whitespace; otherwise throwing an exception.
*
* <pre>Validate.notBlank(myString);</pre>
@@ -460,8 +460,8 @@ public class Validate {
*
* @param <T> the character sequence type
* @param chars the character sequence to check, validated not null by this method
- * @return the validated character sequence (never <code>null</code> method for chaining)
- * @throws NullPointerException if the character sequence is <code>null</code>
+ * @return the validated character sequence (never {@code null} method for chaining)
+ * @throws NullPointerException if the character sequence is {@code null}
* @throws IllegalArgumentException if the character sequence is blank
* @see #notBlank(CharSequence, String, Object...)
*/
@@ -474,25 +474,25 @@ public class Validate {
/**
* <p>Validate that the specified argument array is neither
- * <code>null</code> nor contains any elements that are <code>null</code>;
+ * {@code null} nor contains any elements that are {@code null};
* otherwise throwing an exception with the specified message.
*
* <pre>Validate.noNullElements(myArray, "The array contain null at position %d");</pre>
*
- * <p>If the array is <code>null</code>, then the message in the exception
+ * <p>If the array is {@code null}, then the message in the exception
* is "The validated object is null".</p>
*
- * <p>If the array has a <code>null</code> element, then the iteration
- * index of the invalid element is appended to the <code>values</code>
+ * <p>If the array has a {@code null} element, then the iteration
+ * index of the invalid element is appended to the {@code values}
* argument.</p>
*
* @param <T> the array type
* @param array the array to check, validated not null by this method
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param values the optional values for the formatted exception message, null array not recommended
- * @return the validated array (never <code>null</code> method for chaining)
- * @throws NullPointerException if the array is <code>null</code>
- * @throws IllegalArgumentException if an element is <code>null</code>
+ * @return the validated array (never {@code null} method for chaining)
+ * @throws NullPointerException if the array is {@code null}
+ * @throws IllegalArgumentException if an element is {@code null}
* @see #noNullElements(Object[])
*/
public static <T> T[] noNullElements(T[] array, String message, Object... values) {
@@ -508,23 +508,23 @@ public class Validate {
/**
* <p>Validate that the specified argument array is neither
- * <code>null</code> nor contains any elements that are <code>null</code>;
+ * {@code null} nor contains any elements that are {@code null};
* otherwise throwing an exception.
*
* <pre>Validate.noNullElements(myArray);</pre>
*
- * <p>If the array is <code>null</code>, then the message in the exception
+ * <p>If the array is {@code null}, then the message in the exception
* is "The validated object is null".</p>
*
- * <p>If the array has a <code>null</code> element, then the message in the
+ * <p>If the array has a {@code null} element, then the message in the
* exception is "The validated array contains null element at index:
* " followed by the index.</p>
*
* @param <T> the array type
* @param array the array to check, validated not null by this method
- * @return the validated array (never <code>null</code> method for chaining)
- * @throws NullPointerException if the array is <code>null</code>
- * @throws IllegalArgumentException if an element is <code>null</code>
+ * @return the validated array (never {@code null} method for chaining)
+ * @throws NullPointerException if the array is {@code null}
+ * @throws IllegalArgumentException if an element is {@code null}
* @see #noNullElements(Object[], String, Object...)
*/
public static <T> T[] noNullElements(T[] array) {
@@ -536,25 +536,25 @@ public class Validate {
/**
* <p>Validate that the specified argument iterable is neither
- * <code>null</code> nor contains any elements that are <code>null</code>;
+ * {@code null} nor contains any elements that are {@code null};
* otherwise throwing an exception with the specified message.
*
* <pre>Validate.noNullElements(myCollection, "The collection contains null at position %d");</pre>
*
- * <p>If the iterable is <code>null</code>, then the message in the exception
+ * <p>If the iterable is {@code null}, then the message in the exception
* is "The validated object is null".</p>
*
- * <p>If the iterable has a <code>null</code> element, then the iteration
- * index of the invalid element is appended to the <code>values</code>
+ * <p>If the iterable has a {@code null} element, then the iteration
+ * index of the invalid element is appended to the {@code values}
* argument.</p>
*
* @param <T> the iterable type
* @param iterable the iterable to check, validated not null by this method
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param values the optional values for the formatted exception message, null array not recommended
- * @return the validated iterable (never <code>null</code> method for chaining)
- * @throws NullPointerException if the array is <code>null</code>
- * @throws IllegalArgumentException if an element is <code>null</code>
+ * @return the validated iterable (never {@code null} method for chaining)
+ * @throws NullPointerException if the array is {@code null}
+ * @throws IllegalArgumentException if an element is {@code null}
* @see #noNullElements(Iterable)
*/
public static <T extends Iterable<?>> T noNullElements(T iterable, String message, Object... values) {
@@ -571,23 +571,23 @@ public class Validate {
/**
* <p>Validate that the specified argument iterable is neither
- * <code>null</code> nor contains any elements that are <code>null</code>;
+ * {@code null} nor contains any elements that are {@code null};
* otherwise throwing an exception.
*
* <pre>Validate.noNullElements(myCollection);</pre>
*
- * <p>If the iterable is <code>null</code>, then the message in the exception
+ * <p>If the iterable is {@code null}, then the message in the exception
* is "The validated object is null".</p>
*
- * <p>If the array has a <code>null</code> element, then the message in the
+ * <p>If the array has a {@code null} element, then the message in the
* exception is "The validated iterable contains null element at index:
* " followed by the index.</p>
*
* @param <T> the iterable type
* @param iterable the iterable to check, validated not null by this method
- * @return the validated iterable (never <code>null</code> method for chaining)
- * @throws NullPointerException if the array is <code>null</code>
- * @throws IllegalArgumentException if an element is <code>null</code>
+ * @return the validated iterable (never {@code null} method for chaining)
+ * @throws NullPointerException if the array is {@code null}
+ * @throws IllegalArgumentException if an element is {@code null}
* @see #noNullElements(Iterable, String, Object...)
*/
public static <T extends Iterable<?>> T noNullElements(T iterable) {
@@ -603,7 +603,7 @@ public class Validate {
*
* <pre>Validate.validIndex(myArray, 2, "The array index is invalid: ");</pre>
*
- * <p>If the array is <code>null</code>, then the message of the exception
+ * <p>If the array is {@code null}, then the message of the exception
* is "The validated object is null".</p>
*
* @param <T> the array type
@@ -611,8 +611,8 @@ public class Validate {
* @param index the index to check
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param values the optional values for the formatted exception message, null array not recommended
- * @return the validated array (never <code>null</code> for method chaining)
- * @throws NullPointerException if the array is <code>null</code>
+ * @return the validated array (never {@code null} for method chaining)
+ * @throws NullPointerException if the array is {@code null}
* @throws IndexOutOfBoundsException if the index is invalid
* @see #validIndex(Object[], int)
*/
@@ -630,7 +630,7 @@ public class Validate {
*
* <pre>Validate.validIndex(myArray, 2);</pre>
*
- * <p>If the array is <code>null</code>, then the message of the exception
+ * <p>If the array is {@code null}, then the message of the exception
* is "The validated object is null".</p>
*
* <p>If the index is invalid, then the message of the exception is
@@ -640,8 +640,8 @@ public class Validate {
* @param <T> the array type
* @param array the array to check, validated not null by this method
* @param index the index to check
- * @return the validated array (never <code>null</code> for method chaining)
- * @throws NullPointerException if the array is <code>null</code>
+ * @return the validated array (never {@code null} for method chaining)
+ * @throws NullPointerException if the array is {@code null}
* @throws IndexOutOfBoundsException if the index is invalid
* @see #validIndex(Object[], int, String, Object...)
*/
@@ -658,7 +658,7 @@ public class Validate {
*
* <pre>Validate.validIndex(myCollection, 2, "The collection index is invalid: ");</pre>
*
- * <p>If the collection is <code>null</code>, then the message of the
+ * <p>If the collection is {@code null}, then the message of the
* exception is "The validated object is null".</p>
*
* @param <T> the collection type
@@ -666,8 +666,8 @@ public class Validate {
* @param index the index to check
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param values the optional values for the formatted exception message, null array not recommended
- * @return the validated collection (never <code>null</code> for chaining)
- * @throws NullPointerException if the collection is <code>null</code>
+ * @return the validated collection (never {@code null} for chaining)
+ * @throws NullPointerException if the collection is {@code null}
* @throws IndexOutOfBoundsException if the index is invalid
* @see #validIndex(Collection, int)
*/
@@ -692,8 +692,8 @@ public class Validate {
* @param <T> the collection type
* @param collection the collection to check, validated not null by this method
* @param index the index to check
- * @return the validated collection (never <code>null</code> for method chaining)
- * @throws NullPointerException if the collection is <code>null</code>
+ * @return the validated collection (never {@code null} for method chaining)
+ * @throws NullPointerException if the collection is {@code null}
* @throws IndexOutOfBoundsException if the index is invalid
* @see #validIndex(Collection, int, String, Object...)
*/
@@ -711,7 +711,7 @@ public class Validate {
*
* <pre>Validate.validIndex(myStr, 2, "The string index is invalid: ");</pre>
*
- * <p>If the character sequence is <code>null</code>, then the message
+ * <p>If the character sequence is {@code null}, then the message
* of the exception is "The validated object is null".</p>
*
* @param <T> the character sequence type
@@ -719,8 +719,8 @@ public class Validate {
* @param index the index to check
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param values the optional values for the formatted exception message, null array not recommended
- * @return the validated character sequence (never <code>null</code> for method chaining)
- * @throws NullPointerException if the character sequence is <code>null</code>
+ * @return the validated character sequence (never {@code null} for method chaining)
+ * @throws NullPointerException if the character sequence is {@code null}
* @throws IndexOutOfBoundsException if the index is invalid
* @see #validIndex(CharSequence, int)
*/
@@ -738,7 +738,7 @@ public class Validate {
*
* <pre>Validate.validIndex(myStr, 2);</pre>
*
- * <p>If the character sequence is <code>null</code>, then the message
+ * <p>If the character sequence is {@code null}, then the message
* of the exception is "The validated object is
* null".</p>
*
@@ -749,8 +749,8 @@ public class Validate {
* @param <T> the character sequence type
* @param chars the character sequence to check, validated not null by this method
* @param index the index to check
- * @return the validated character sequence (never <code>null</code> for method chaining)
- * @throws NullPointerException if the character sequence is <code>null</code>
+ * @return the validated character sequence (never {@code null} for method chaining)
+ * @throws NullPointerException if the character sequence is {@code null}
* @throws IndexOutOfBoundsException if the index is invalid
* @see #validIndex(CharSequence, int, String, Object...)
*/
@@ -762,7 +762,7 @@ public class Validate {
//---------------------------------------------------------------------------------
/**
- * <p>Validate that the stateful condition is <code>true</code>; otherwise
+ * <p>Validate that the stateful condition is {@code true}; otherwise
* throwing an exception. This method is useful when validating according
* to an arbitrary boolean expression, such as validating a
* primitive number or using your own custom validation expression.</p>
@@ -775,7 +775,7 @@ public class Validate {
* false".</p>
*
* @param expression the boolean expression to check
- * @throws IllegalStateException if expression is <code>false</code>
+ * @throws IllegalStateException if expression is {@code false}
* @see #validState(boolean, String, Object...)
*/
public static void validState(boolean expression) {
@@ -785,7 +785,7 @@ public class Validate {
}
/**
- * <p>Validate that the stateful condition is <code>true</code>; otherwise
+ * <p>Validate that the stateful condition is {@code true}; otherwise
* throwing an exception with the specified message. This method is useful when
* validating according to an arbitrary boolean expression, such as validating a
* primitive number or using your own custom validation expression.</p>
@@ -795,7 +795,7 @@ public class Validate {
* @param expression the boolean expression to check
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null
* @param values the optional values for the formatted exception message, null array not recommended
- * @throws IllegalStateException if expression is <code>false</code>
+ * @throws IllegalStateException if expression is {@code false}
* @see #validState(boolean)
*/
public static void validState(boolean expression, String message, Object... values) {
Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/builder/Builder.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/builder/Builder.java?rev=1078032&r1=1078031&r2=1078032&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/builder/Builder.java (original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/builder/Builder.java Fri Mar 4 16:07:14 2011
@@ -32,7 +32,7 @@ package org.apache.commons.lang3.builder
*
* <p>
* It is a recommended practice that the methods supplied to configure the
- * object or result being built return a reference to <code>this</code> so that
+ * object or result being built return a reference to {@code this} so that
* method calls can be chained together.
* </p>
*