X-Git-Url: http://git.nikiroo.be/?p=nikiroo-utils.git;a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Futils%2FStringUtils.java;h=a6117a04053e863b3d9952c4fccd33f0533f33c7;hp=0ceb673104902170a6860294a4aa37b19547a610;hb=805005449dacb1e7b825db63836bf100e472ddd0;hpb=3f8349b761d29cd3d5381f076d706014574eeb43

diff --git a/src/be/nikiroo/utils/StringUtils.java b/src/be/nikiroo/utils/StringUtils.java
index 0ceb673..a6117a0 100644
--- a/src/be/nikiroo/utils/StringUtils.java
+++ b/src/be/nikiroo/utils/StringUtils.java
@@ -51,7 +51,7 @@ public class StringUtils {
 	 * @return the resulting {@link String} of size <i>size</i>
 	 */
 	static public String padString(String text, int width) {
-		return padString(text, width, true, Alignment.Beginning);
+		return padString(text, width, true, null);
 	}
 
 	/**
@@ -67,13 +67,17 @@ public class StringUtils {
 	 *            cut the {@link String} shorter if needed
 	 * @param align
 	 *            align the {@link String} in this position if we have enough
-	 *            space
+	 *            space (default is Alignment.Beginning)
 	 * 
 	 * @return the resulting {@link String} of size <i>size</i> minimum
 	 */
 	static public String padString(String text, int width, boolean cut,
 			Alignment align) {
 
+		if (align == null) {
+			align = Alignment.Beginning;
+		}
+
 		if (width >= 0) {
 			if (text == null)
 				text = "";
@@ -164,11 +168,15 @@ public class StringUtils {
 	}
 
 	/**
-	 * Convert between time in milliseconds to {@link String} in a "static" way
-	 * (to exchange data over the wire, for instance).
+	 * Convert between the time in milliseconds to a {@link String} in a "fixed"
+	 * way (to exchange data over the wire, for instance).
+	 * <p>
+	 * Precise to the second.
 	 * 
 	 * @param time
-	 *            the time in milliseconds
+	 *            the specified number of milliseconds since the standard base
+	 *            time known as "the epoch", namely January 1, 1970, 00:00:00
+	 *            GMT
 	 * 
 	 * @return the time as a {@link String}
 	 */
@@ -178,13 +186,16 @@ public class StringUtils {
 	}
 
 	/**
-	 * Convert between time as a {@link String} to milliseconds in a "static"
+	 * Convert between the time as a {@link String} to milliseconds in a "fixed"
 	 * way (to exchange data over the wire, for instance).
+	 * <p>
+	 * Precise to the second.
 	 * 
 	 * @param displayTime
 	 *            the time as a {@link String}
 	 * 
-	 * @return the time in milliseconds
+	 * @return the number of milliseconds since the standard base time known as
+	 *         "the epoch", namely January 1, 1970, 00:00:00 GMT
 	 */
 	static public long toTime(String displayTime) {
 		SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
@@ -289,6 +300,14 @@ public class StringUtils {
 				HtmlEscapeLevel.LEVEL_1_ONLY_MARKUP_SIGNIFICANT);
 	}
 
+	/**
+	 * Zip the data and then encode it into Base64.
+	 * 
+	 * @param data
+	 *            the data
+	 * 
+	 * @return the Base64 zipped version
+	 */
 	public static String zip64(String data) {
 		try {
 			return Base64.encodeBytes(data.getBytes(), Base64.GZIP);
@@ -298,6 +317,17 @@ public class StringUtils {
 		}
 	}
 
+	/**
+	 * Unconvert from Base64 then unzip the content.
+	 * 
+	 * @param data
+	 *            the data in Base64 format
+	 * 
+	 * @return the raw data
+	 * 
+	 * @throws IOException
+	 *             in case of I/O error
+	 */
 	public static String unzip64(String data) throws IOException {
 		ByteArrayInputStream in = new ByteArrayInputStream(Base64.decode(data,
 				Base64.GZIP));