You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2016/08/26 09:53:41 UTC
svn commit: r1757809 - in
/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util:
./ exception/
Author: elecharny
Date: Fri Aug 26 09:53:40 2016
New Revision: 1757809
URL: http://svn.apache.org/viewvc?rev=1757809&view=rev
Log:
fixed some Javadoc errors
Modified:
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Chars.java
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/ExpansibleByteBuffer.java
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/FileUtils.java
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/GeneralizedTime.java
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Hex.java
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/IOUtils.java
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/OsgiUtils.java
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/SequencedHashMap.java
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Serialize.java
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Strings.java
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/RuntimeMultiException.java
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Chars.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Chars.java?rev=1757809&r1=1757808&r2=1757809&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Chars.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Chars.java Fri Aug 26 09:53:40 2016
@@ -27,7 +27,7 @@ package org.apache.directory.api.util;
*/
public final class Chars
{
- /** <alpha> ::= [0x41-0x5A] | [0x61-0x7A] */
+ /** <alpha> ::= [0x41-0x5A] | [0x61-0x7A] */
private static final boolean[] ALPHA =
{
false, false, false, false, false, false, false, false,
@@ -38,16 +38,17 @@ public final class Chars
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
- false, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, false, false, false, false, false,
- false, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, false, false, false, false, false
- };
- /** <alpha-lower-case> ::= [0x61-0x7A] */
+ false, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, false, false, false, false, false,
+ false, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, false, false, false, false, false
+ };
+
+ /** <alpha-lower-case> ::= [0x61-0x7A] */
private static final boolean[] ALPHA_LOWER_CASE =
{
false, false, false, false, false, false, false, false,
@@ -62,12 +63,13 @@ public final class Chars
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
- false, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, false, false, false, false, false
- };
- /** <alpha-upper-case> ::= [0x41-0x5A] */
+ false, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, false, false, false, false, false
+ };
+
+ /** <alpha-upper-case> ::= [0x41-0x5A] */
private static final boolean[] ALPHA_UPPER_CASE =
{
false, false, false, false, false, false, false, false,
@@ -78,16 +80,17 @@ public final class Chars
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
- false, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, false, false, false, false, false,
+ false, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, false, false, false, false, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
- };
- /** <alpha-digit> | <digit> */
+ };
+
+ /** <alpha-digit> | <digit> */
private static final boolean[] ALPHA_DIGIT =
{
false, false, false, false, false, false, false, false,
@@ -96,18 +99,19 @@ public final class Chars
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
- true, true, true, true, true, true, true, true,
- true, true, false, false, false, false, false, false,
- false, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, false, false, false, false, false,
- false, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, false, false, false, false, false
- };
- /** <alpha> | <digit> | '-' */
+ true, true, true, true, true, true, true, true,
+ true, true, false, false, false, false, false, false,
+ false, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, false, false, false, false, false,
+ false, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, false, false, false, false, false
+ };
+
+ /** <alpha> | <digit> | '-' */
private static final boolean[] CHAR =
{
false, false, false, false, false, false, false, false,
@@ -116,17 +120,18 @@ public final class Chars
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, true, false, false,
- true, true, true, true, true, true, true, true,
- true, true, false, false, false, false, false, false,
- false, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, false, false, false, false, false,
- false, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, true, true, true, true, true,
- true, true, true, false, false, false, false, false
- };
+ true, true, true, true, true, true, true, true,
+ true, true, false, false, false, false, false, false,
+ false, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, false, false, false, false, false,
+ false, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, true, true, true, true, true,
+ true, true, true, false, false, false, false, false
+ };
+
/** '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' */
private static final boolean[] DIGIT =
{
@@ -136,8 +141,8 @@ public final class Chars
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
- true, true, true, true, true, true, true, true,
- true, true, false, false, false, false, false, false,
+ true, true, true, true, true, true, true, true,
+ true, true, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
@@ -146,8 +151,9 @@ public final class Chars
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false
- };
- /** <hex> ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66] */
+ };
+
+ /** <hex> ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66] */
private static final boolean[] HEX =
{
false, false, false, false, false, false, false, false,
@@ -156,16 +162,17 @@ public final class Chars
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
- true, true, true, true, true, true, true, true,
- true, true, false, false, false, false, false, false,
- false, true, true, true, true, true, true, false,
+ true, true, true, true, true, true, true, true,
+ true, true, false, false, false, false, false, false,
+ false, true, true, true, true, true, true, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
- false, true, true, true, true, true, true, false,
+ false, true, true, true, true, true, true, false,
false, false, false, false, false, false, false, false,
false, false, false, false, false, false, false, false,
- false, false, false, false, false, false, false, false };
+ false, false, false, false, false, false, false, false
+ };
private Chars()
@@ -287,7 +294,7 @@ public final class Chars
/**
* Test if the current byte is an Alpha character :
- * <alpha> ::= [0x41-0x5A] | [0x61-0x7A]
+ * <alpha> ::= [0x41-0x5A] | [0x61-0x7A]
*
* @param c The byte to test
*
@@ -302,7 +309,7 @@ public final class Chars
/**
* Test if the current character is an Alpha character :
- * <alpha> ::= [0x41-0x5A] | [0x61-0x7A]
+ * <alpha> ::= [0x41-0x5A] | [0x61-0x7A]
*
* @param c The char to test
*
@@ -316,7 +323,7 @@ public final class Chars
/**
- * Test if the current character is an Alpha character : <alpha> ::=
+ * Test if the current character is an Alpha character : <alpha> ::=
* [0x41-0x5A] | [0x61-0x7A]
*
* @param bytes The buffer which contains the data
@@ -347,7 +354,7 @@ public final class Chars
/**
- * Test if the current character is an Alpha character : <alpha> ::=
+ * Test if the current character is an Alpha character : <alpha> ::=
* [0x41-0x5A] | [0x61-0x7A]
*
* @param chars The buffer which contains the data
@@ -378,7 +385,7 @@ public final class Chars
/**
- * Test if the current character is an Alpha character : <alpha> ::=
+ * Test if the current character is an Alpha character : <alpha> ::=
* [0x41-0x5A] | [0x61-0x7A]
*
* @param string The string which contains the data
@@ -416,8 +423,8 @@ public final class Chars
/**
- * Test if the current character is a lowercased Alpha character : <br/>
- * <alpha> ::= [0x61-0x7A]
+ * Test if the current character is a lowercased Alpha character : <br>
+ * <alpha> ::= [0x61-0x7A]
*
* @param string The string which contains the data
* @param index Current position in the string
@@ -454,8 +461,8 @@ public final class Chars
/**
- * Test if the current character is a uppercased Alpha character : <br/>
- * <alpha> ::= [0x61-0x7A]
+ * Test if the current character is a uppercased Alpha character : <br>
+ * <alpha> ::= [0x61-0x7A]
*
* @param string The string which contains the data
* @param index Current position in the string
@@ -494,7 +501,7 @@ public final class Chars
/**
* Check if the current character is an 7 bits ASCII CHAR (between 0 and
* 127).
- * <char> ::= <alpha> | <digit>
+ * <char> ::= <alpha> | <digit>
*
* @param string The string which contains the data
* @param index Current position in the string
@@ -531,7 +538,7 @@ public final class Chars
/**
* Check if the current character is an 7 bits ASCII CHAR (between 0 and
- * 127). <char> ::= <alpha> | <digit> | '-'
+ * 127). <char> ::= <alpha> | <digit> | '-'
*
* @param bytes The buffer which contains the data
* @param index Current position in the buffer
@@ -561,7 +568,7 @@ public final class Chars
/**
* Check if the current character is an 7 bits ASCII CHAR (between 0 and
- * 127). <char> ::= <alpha> | <digit> | '-'
+ * 127). <char> ::= <alpha> | <digit> | '-'
*
* @param chars The buffer which contains the data
* @param index Current position in the buffer
@@ -591,7 +598,7 @@ public final class Chars
/**
* Check if the current character is an 7 bits ASCII CHAR (between 0 and
- * 127). <char> ::= <alpha> | <digit> | '-'
+ * 127). <char> ::= <alpha> | <digit> | '-'
*
* @param string The string which contains the data
* @param index Current position in the string
@@ -628,7 +635,7 @@ public final class Chars
/**
* Check if the current character is an 7 bits ASCII CHAR (between 0 and
- * 127). <char> ::= <alpha> | <digit> | '-'
+ * 127). <char> ::= <alpha> | <digit> | '-'
*
* @param c The char we want to check
* @return The position of the next character, if the current one is a CHAR.
@@ -670,7 +677,7 @@ public final class Chars
/**
- * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
+ * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
* '3' | '4' | '5' | '6' | '7' | '8' | '9'
*
* @param bytes The buffer which contains the data
@@ -690,7 +697,7 @@ public final class Chars
/**
- * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
+ * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
* '3' | '4' | '5' | '6' | '7' | '8' | '9'
*
* @param car the character to test
@@ -704,7 +711,7 @@ public final class Chars
/**
- * Test if the current byte is a digit <digit> ::= '0' | '1' | '2' |
+ * Test if the current byte is a digit <digit> ::= '0' | '1' | '2' |
* '3' | '4' | '5' | '6' | '7' | '8' | '9'
*
* @param car the byte to test
@@ -718,7 +725,7 @@ public final class Chars
/**
- * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
+ * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
* '3' | '4' | '5' | '6' | '7' | '8' | '9'
*
* @param bytes The buffer which contains the data
@@ -739,7 +746,7 @@ public final class Chars
/**
- * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
+ * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
* '3' | '4' | '5' | '6' | '7' | '8' | '9'
*
* @param chars The buffer which contains the data
@@ -760,7 +767,7 @@ public final class Chars
/**
- * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
+ * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
* '3' | '4' | '5' | '6' | '7' | '8' | '9'
*
* @param string The string which contains the data
@@ -789,7 +796,7 @@ public final class Chars
/**
- * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
+ * Test if the current character is a digit <digit> ::= '0' | '1' | '2' |
* '3' | '4' | '5' | '6' | '7' | '8' | '9'
*
* @param chars The buffer which contains the data
@@ -810,7 +817,7 @@ public final class Chars
/**
* Check if the current char is an Hex Char
- * <hex> ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66]
+ * <hex> ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66]
*
* @param c The char we want to check
* @return <code>true</code> if the current char is a Hex char
@@ -823,7 +830,7 @@ public final class Chars
/**
* Check if the current byte is an Hex Char
- * <hex> ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66]
+ * <hex> ::= [0x30-0x39] | [0x41-0x46] | [0x61-0x66]
*
* @param b The byte we want to check
* @return <code>true</code> if the current byte is a Hex byte
@@ -835,7 +842,7 @@ public final class Chars
/**
- * Check if the current character is an Hex Char <hex> ::= [0x30-0x39] |
+ * Check if the current character is an Hex Char <hex> ::= [0x30-0x39] |
* [0x41-0x46] | [0x61-0x66]
*
* @param bytes The buffer which contains the data
@@ -858,7 +865,7 @@ public final class Chars
/**
- * Check if the current character is an Hex Char <hex> ::= [0x30-0x39] |
+ * Check if the current character is an Hex Char <hex> ::= [0x30-0x39] |
* [0x41-0x46] | [0x61-0x66]
*
* @param chars The buffer which contains the data
@@ -881,7 +888,7 @@ public final class Chars
/**
- * Check if the current character is an Hex Char <hex> ::= [0x30-0x39] |
+ * Check if the current character is an Hex Char <hex> ::= [0x30-0x39] |
* [0x41-0x46] | [0x61-0x66]
*
* @param string The string which contains the data
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/ExpansibleByteBuffer.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/ExpansibleByteBuffer.java?rev=1757809&r1=1757808&r2=1757809&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/ExpansibleByteBuffer.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/ExpansibleByteBuffer.java Fri Aug 26 09:53:40 2016
@@ -103,6 +103,8 @@ public class ExpansibleByteBuffer
* Get's the bytes, the backing store for this buffer. Note
* that you need to use the position index to determine where
* to stop reading from this buffer.
+ *
+ * @return The interned Byte[]
*/
public final byte[] buffer()
{
@@ -112,6 +114,8 @@ public class ExpansibleByteBuffer
/**
* Get's a copy of the bytes used.
+ *
+ * @return A copy of the interned Byte[]
*/
public final byte[] copyOfUsedBytes()
{
@@ -123,6 +127,8 @@ public class ExpansibleByteBuffer
/**
* Appends the bytes to this buffer.
+ *
+ * @param bytes The byte[] to append to the buffer
*/
public final void append( byte[] bytes )
{
@@ -138,6 +144,8 @@ public class ExpansibleByteBuffer
/**
* Appends a byte to this buffer.
+ *
+ * @param b The byte to append to the buffer
*/
public final void append( byte b )
{
@@ -154,6 +162,8 @@ public class ExpansibleByteBuffer
/**
* Appends an int to this buffer. WARNING: the int is truncated to
* a byte value.
+ *
+ * @param val The integer to append to the buffer
*/
public final void append( int val )
{
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/FileUtils.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/FileUtils.java?rev=1757809&r1=1757808&r2=1757809&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/FileUtils.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/FileUtils.java Fri Aug 26 09:53:40 2016
@@ -110,7 +110,7 @@ public final class FileUtils
* only if the specific file is.
* <p>
* <b>Note:</b> the current implementation always returns {@code false} if the system
- * is detected as Windows using {@link FilenameUtils#isSystemWindows()}
+ * is detected as Windows
* <p>
* For code that runs on Java 1.7 or later, use the following method instead:
* <br>
@@ -301,9 +301,6 @@ public final class FileUtils
* @param encoding the encoding to use, {@code null} means platform default
* @return the file contents, never {@code null}
* @throws IOException in case of an I/O error
- * @throws UnsupportedCharsetException
- * thrown instead of {@link UnsupportedEncodingException} in version 2.2 if the encoding is not
- * supported.
* @since 2.3
*/
public static String readFileToString( File file, String encoding ) throws IOException
@@ -369,7 +366,7 @@ public final class FileUtils
* @param file the file to write
* @param data the content to write to the file
* @throws IOException in case of an I/O error
- * @deprecated 2.5 use {@link #writeStringToFile(File, String, Charset)} instead
+ * @deprecated 2.5 use {@link #writeStringToFile(File, String, Charset, boolean)} instead
*/
@Deprecated
public static void writeStringToFile( File file, String data ) throws IOException
@@ -551,7 +548,6 @@ public final class FileUtils
* @throws IOException if source or destination is invalid
* @throws IOException if an IO error occurs during copying
* @throws IOException if the output file length is not the same as the input file length after the copy completes
- * @see #copyFileToDirectory(File, File)
* @see #copyFile(File, File, boolean)
*/
public static void copyFile( File srcFile, File destFile ) throws IOException
@@ -583,7 +579,6 @@ public final class FileUtils
* @throws IOException if source or destination is invalid
* @throws IOException if an IO error occurs during copying
* @throws IOException if the output file length is not the same as the input file length after the copy completes
- * @see #copyFileToDirectory(File, File, boolean)
* @see #doCopyFile(File, File, boolean)
*/
public static void copyFile( File srcFile, File destFile, boolean preserveFileDate ) throws IOException
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/GeneralizedTime.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/GeneralizedTime.java?rev=1757809&r1=1757808&r2=1757809&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/GeneralizedTime.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/GeneralizedTime.java Fri Aug 26 09:53:40 2016
@@ -73,41 +73,40 @@ import org.apache.directory.api.i18n.I18
* g-differential = ( MINUS / PLUS ) hour [ minute ]
* MINUS = %x2D ; minus sign ("-")
*
- * The <DOT>, <COMMA>, and <PLUS> rules are defined in [RFC4512].
+ * The <DOT>, <COMMA>, and <PLUS> rules are defined in [RFC4512].
*
* The above ABNF allows character strings that do not represent valid
* dates (in the Gregorian calendar) and/or valid times (e.g., February
* 31, 1994). Such character strings SHOULD be considered invalid for
* this syntax.
- *
+ * <br>
* The time value represents coordinated universal time (equivalent to
- * Greenwich Mean Time) if the "Z" form of <g-time-zone> is used;
+ * Greenwich Mean Time) if the "Z" form of <g-time-zone> is used;
* otherwise, the value represents a local time in the time zone
- * indicated by <g-differential>. In the latter case, coordinated
+ * indicated by <g-differential>. In the latter case, coordinated
* universal time can be calculated by subtracting the differential from
- * the local time. The "Z" form of <g-time-zone> SHOULD be used in
- * preference to <g-differential>.
- *
- * If <minute> is omitted, then <fraction> represents a fraction of an
- * hour; otherwise, if <second> and <leap-second> are omitted, then
- * <fraction> represents a fraction of a minute; otherwise, <fraction>
+ * the local time. The "Z" form of <g-time-zone> SHOULD be used in
+ * preference to <g-differential>.
+ * <br>
+ * If <minute> is omitted, then <fraction> represents a fraction of an
+ * hour; otherwise, if <second> and <leap-second> are omitted, then
+ * <fraction> represents a fraction of a minute; otherwise, <fraction>
* represents a fraction of a second.
*
* Examples:
* 199412161032Z
* 199412160532-0500
- *
+ *
* Both example values represent the same coordinated universal time:
* 10:32 AM, December 16, 1994.
- *
+ * <br>
* The LDAP definition for the Generalized Time syntax is:
- *
+ *
* ( 1.3.6.1.4.1.1466.115.121.1.24 DESC 'Generalized Time' )
- *
+ *
* This syntax corresponds to the GeneralizedTime ASN.1 type from
* [ASN.1], with the constraint that local time without a differential
* SHALL NOT be used.
- *
* </pre>
*/
public class GeneralizedTime implements Comparable<GeneralizedTime>
@@ -204,6 +203,22 @@ public class GeneralizedTime implements
}
+ private void setUp( Calendar newCalendar )
+ {
+ if ( newCalendar == null )
+ {
+ throw new IllegalArgumentException( I18n.err( I18n.ERR_04358 ) );
+ }
+
+ this.calendar = newCalendar;
+ upGeneralizedTime = null;
+ upFormat = Format.YEAR_MONTH_DAY_HOUR_MIN_SEC_FRACTION;
+ upTimeZoneFormat = TimeZoneFormat.Z;
+ upFractionDelimiter = FractionDelimiter.DOT;
+ upFractionLength = 3;
+ }
+
+
/**
* Creates a new instance of GeneralizedTime, based on the
* given generalized time string.
@@ -351,22 +366,6 @@ public class GeneralizedTime implements
}
- private void setUp( Calendar newCalendar )
- {
- if ( newCalendar == null )
- {
- throw new IllegalArgumentException( I18n.err( I18n.ERR_04358 ) );
- }
-
- this.calendar = newCalendar;
- upGeneralizedTime = null;
- upFormat = Format.YEAR_MONTH_DAY_HOUR_MIN_SEC_FRACTION;
- upTimeZoneFormat = TimeZoneFormat.Z;
- upFractionDelimiter = FractionDelimiter.DOT;
- upFractionLength = 3;
- }
-
-
private void parseTimezone( int pos ) throws ParseException
{
if ( upGeneralizedTime.length() < pos + 1 )
@@ -778,6 +777,7 @@ public class GeneralizedTime implements
result[pos++] = ( byte ) ( ( millisecond / 10 ) + '0' );
+ //if ( millisecond > 0 )
result[pos++] = ( byte ) ( ( millisecond % 10 ) + '0' );
break;
@@ -970,61 +970,87 @@ public class GeneralizedTime implements
*
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
- @Override
public int compareTo( GeneralizedTime other )
{
return calendar.compareTo( other.calendar );
}
+ /**
+ * @return A Date representing the time as milliseconds
+ */
public long getTime()
{
return calendar.getTimeInMillis();
}
+ /**
+ * @return A Date representing the time
+ */
public Date getDate()
{
return calendar.getTime();
}
+ /**
+ * @return The year part of the date
+ */
public int getYear()
{
return calendar.get( Calendar.YEAR );
}
+ /**
+ * @return The month part of the date
+ */
public int getMonth()
{
return calendar.get( Calendar.MONTH );
}
+ /**
+ * @return The day part of the date
+ */
public int getDay()
{
return calendar.get( Calendar.DATE );
}
+ /**
+ * @return The hours part of the date
+ */
public int getHour()
{
return calendar.get( Calendar.HOUR_OF_DAY );
}
+ /**
+ * @return The minutes part of the date
+ */
public int getMinutes()
{
return calendar.get( Calendar.MINUTE );
}
+ /**
+ * @return The seconds part of the date
+ */
public int getSeconds()
{
return calendar.get( Calendar.SECOND );
}
+ /**
+ * @return The fractional (ie, milliseconds) part of the date
+ */
public int getFraction()
{
return calendar.get( Calendar.MILLISECOND );
@@ -1032,10 +1058,11 @@ public class GeneralizedTime implements
/**
- *
+ * Get a Dat einstance from a given String
*
- * @param zuluTime
- * @return
+ * @param zuluTime The time as a String
+ * @return A Date instance
+ * @throws ParseException If the String is not a valid date
*/
public static Date getDate( String zuluTime ) throws ParseException
{
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Hex.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Hex.java?rev=1757809&r1=1757808&r2=1757809&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Hex.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Hex.java Fri Aug 26 09:53:40 2016
@@ -129,7 +129,7 @@ public final class Hex
*
* @param str the string to decode
* @return the decoded string
- * @throws InvalidNameException
+ * @throws InvalidNameException If we can't decode the String to an UTF-8 String
*/
public static String decodeHexString( String str ) throws InvalidNameException
{
@@ -165,6 +165,7 @@ public final class Hex
*
* @param str the string containing hex escapes
* @return the converted byte[]
+ * @throws InvalidNameException If we can't convert the String to a byte[]
*/
public static byte[] convertEscapedHex( String str ) throws InvalidNameException
{
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/IOUtils.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/IOUtils.java?rev=1757809&r1=1757808&r2=1757809&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/IOUtils.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/IOUtils.java Fri Aug 26 09:53:40 2016
@@ -234,7 +234,6 @@ public final class IOUtils
*
* @param charset The name of the requested charset, may be null.
* @return a Charset for the named charset
- * @throws UnsupportedCharsetException If the named charset is unavailable
*/
public static Charset toCharset( String charset )
{
@@ -609,7 +608,6 @@ public final class IOUtils
* the reader to wrap or return (not null)
* @return the given reader or a new {@link BufferedReader} for the given reader
* @since 2.2
- * @see #buffer(Reader)
* @throws NullPointerException if the input parameter is null
*/
public static BufferedReader toBufferedReader( Reader reader )
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/OsgiUtils.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/OsgiUtils.java?rev=1757809&r1=1757808&r2=1757809&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/OsgiUtils.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/OsgiUtils.java Fri Aug 26 09:53:40 2016
@@ -53,6 +53,8 @@ public final class OsgiUtils
* classpath. The provided filter if not null is used to prune classpath
* elements. Any uses terms found are stripped from the bundles.
*
+ * @param filter The filter to use on the files
+ * @param pkgs The set of packages to use
* @return All the exported packages of all bundles on the classpath.
*/
public static Set<String> getAllBundleExports( FileFilter filter, Set<String> pkgs )
@@ -83,10 +85,11 @@ public final class OsgiUtils
/**
- * Splits an Package-Export OSGi Manifest Attribute value into packages
+ * Splits a Package-Export OSGi Manifest Attribute value into packages
* while stripping away the key/value properties.
*
* @param exports The Package-Export OSGi Manifest Attribute value.
+ * @param pkgs The set that will contain the found packages.
* @return The set of exported packages without properties.
*/
public static Set<String> splitIntoPackages( String exports, Set<String> pkgs )
@@ -142,6 +145,12 @@ public final class OsgiUtils
}
+ /**
+ * Get the files that fits a given filter
+ *
+ * @param filter The filter in use
+ * @return The set of Files that match the filter
+ */
public static Set<File> getClasspathCandidates( FileFilter filter )
{
Set<File> candidates = new HashSet<>();
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/SequencedHashMap.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/SequencedHashMap.java?rev=1757809&r1=1757808&r2=1757809&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/SequencedHashMap.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/SequencedHashMap.java Fri Aug 26 09:53:40 2016
@@ -248,6 +248,8 @@ public class SequencedHashMap implements
* Construct a new sequenced hash map and add all the elements in the
* specified map. The order in which the mappings in the specified map are
* added is defined by {@link #putAll(Map)}.
+ *
+ * @param m The original map
*/
public SequencedHashMap( Map m )
{
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Serialize.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Serialize.java?rev=1757809&r1=1757808&r2=1757809&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Serialize.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Serialize.java Fri Aug 26 09:53:40 2016
@@ -41,6 +41,7 @@ public final class Serialize
* @param value The value to serialize
* @param buffer The buffer to store the value into
* @param pos The position where we serialize the integer
+ * @return The new position in the byte[]
*/
public static int serialize( int value, byte[] buffer, int pos )
{
@@ -64,6 +65,7 @@ public final class Serialize
* @param value The value to serialize
* @param buffer The buffer to store the value into
* @param pos The position where we serialize the byte[]
+ * @return The new position in the byte[]
*/
public static int serialize( byte[] value, byte[] buffer, int pos )
{
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Strings.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Strings.java?rev=1757809&r1=1757808&r2=1757809&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Strings.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Strings.java Fri Aug 26 09:53:40 2016
@@ -410,6 +410,8 @@ public final class Strings
* more efficient.
*
* @see Strings#deepTrim( String )
+ * @param string The String to modify
+ * @return The modified String
*/
public static String deepTrimToLower( String string )
{
@@ -563,8 +565,8 @@ public final class Strings
* This method is used to insert HTML block dynamically
*
* @param source the HTML code to be processes
- * @param replaceNl if true '\n' will be replaced by <br>
- * @param replaceTag if true '<' will be replaced by < and '>' will be replaced
+ * @param replaceNl if true '\n' will be replaced by <br>
+ * @param replaceTag if true '<' will be replaced by < and '>' will be replaced
* by >
* @param replaceQuote if true '\"' will be replaced by "
* @return the formated html block
@@ -707,7 +709,7 @@ public final class Strings
* function works only for character between 0 and 127, as it does compare a
* byte and a char (which is 16 bits wide)
*
- * @param byteArray The buffer which contains the data
+ * @param charArray The buffer which contains the data
* @param index Current position in the buffer
* @param car The character we want to compare with the current buffer position
* @return <code>true</code> if the current character equals the given character.
@@ -1133,6 +1135,7 @@ public final class Strings
* </pre>
*
* @param chars the chars array to be trimmed, may be null
+ * @param pos The position in the char[]
* @return the position of the first char which is not a space, or the last
* position of the array.
*/
@@ -1168,6 +1171,7 @@ public final class Strings
* </pre>
*
* @param string the string to be trimmed, may be null
+ * @param pos The position in the String
* @param pos The starting position
*/
public static void trimLeft( String string, Position pos )
@@ -1204,6 +1208,7 @@ public final class Strings
* </pre>
*
* @param bytes the byte array to be trimmed, may be null
+ * @param pos The position in the byte[]
* @param pos The starting position
*/
public static void trimLeft( byte[] bytes, Position pos )
@@ -1240,6 +1245,7 @@ public final class Strings
* </pre>
*
* @param bytes the byte array to be trimmed, may be null
+ * @param pos The position in the byte[]
* @return the position of the first byte which is not a space, or the last
* position of the array.
*/
@@ -1360,6 +1366,7 @@ public final class Strings
* </pre>
*
* @param chars the chars array to be trimmed, may be null
+ * @param pos The position in the char[]
* @return the position of the first char which is not a space, or the last
* position of the array.
*/
@@ -1395,6 +1402,7 @@ public final class Strings
* </pre>
*
* @param string the string to be trimmed, may be null
+ * @param pos The position in the String
* @return the position of the first char which is not a space, or the last
* position of the string.
*/
@@ -1435,6 +1443,7 @@ public final class Strings
* </pre>
*
* @param bytes the byte array to be trimmed, may be null
+ * @param pos The position in the byte[]
* @return the position of the first char which is not a space, or the last
* position of the byte array.
*/
@@ -1482,6 +1491,7 @@ public final class Strings
* </pre>
*
* @param bytes the byte array to be trimmed, may be null
+ * @param pos The position in the byte[]
* @return the position of the first char which is not a space, or the last
* position of the array.
*/
@@ -1863,11 +1873,13 @@ public final class Strings
* Rewrote the toLowercase method to improve performances.
* In Ldap, attributesType are supposed to use ASCII chars :
* 'a'-'z', 'A'-'Z', '0'-'9', '.' and '-' only.
- *
+ * <br>
+ * Deprecated : Use {@link #toLowerCaseAscii(String)}
+ *
* @param value The String to lowercase
* @return The lowercase string
- * @Deprecated Use {@link #toLowerCaseAscii(String)}
*/
+ @Deprecated
public static String toLowerCase( String value )
{
if ( ( null == value ) || ( value.length() == 0 ) )
@@ -1940,11 +1952,12 @@ public final class Strings
* Rewrote the toUppercase method to improve performances.
* In Ldap, attributesType are supposed to use ASCII chars :
* 'a'-'z', 'A'-'Z', '0'-'9', '.' and '-' only. We also add the '_' char
- *
+ * <br>
+ * Deprecated Use {@link #toUpperCaseAscii(String)}
* @param value The String to uppercase
* @return The uppercase string
- * @Deprecated Use {@link toUpperCaseAscii(String)}
*/
+ @Deprecated
public static String toUpperCase( String value )
{
if ( ( null == value ) || ( value.length() == 0 ) )
@@ -1991,7 +2004,7 @@ public final class Strings
/**
* <p>
- * Converts a String to upper case as per {@link String#toUpperCase( Locale.ROOT )}.
+ * Converts a String to upper case as per {@link String#toUpperCase( Locale )}.
* </p>
* <p>
* A <code>null</code> input String returns <code>null</code>.
@@ -2333,7 +2346,7 @@ public final class Strings
* Create a new UUID using a long as the least significant bits
*
* @param value The least significant bits.
- * @return
+ * @return The created UUID
*/
public static String getUUID( long value )
{
@@ -2375,6 +2388,10 @@ public final class Strings
/**
* @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
+ * @param b1 The first byte[] to compare
+ * @param b2 The second byte[] to compare
+ * @return -1 if the first byte[] is inferior to the second one, 1 if teh first byte[]
+ * is superior to the second one, 0 if they are equal.
*/
public static int compare( byte[] b1, byte[] b2 )
{
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/RuntimeMultiException.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/RuntimeMultiException.java?rev=1757809&r1=1757808&r2=1757809&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/RuntimeMultiException.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/RuntimeMultiException.java Fri Aug 26 09:53:40 2016
@@ -66,6 +66,7 @@ public class RuntimeMultiException exten
* Constructs an Exception with a detailed message.
*
* @param message The message associated with the exception.
+ * @param t The Throwable that causes the Exception
*/
public RuntimeMultiException( String message, Throwable t )
{