[portal-commits] JBoss Portal SVN: r10689 - in modules/common/trunk/common/src: main/java/org/jboss/portal/common/text and 2 other directories.

Author: chris.laprun(a)jboss.com Date: 2008-04-22 01:39:57 -0400 (Tue, 22 Apr 2008) New Revision: 10689 Modified: modules/common/trunk/common/src/main/java/org/jboss/portal/common/io/WriterCharWriter.java modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/AbstractCharEncoder.java modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/CharBuffer.java modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/CharEncoder.java modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/EntityEncoder.java modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/FastURLDecoder.java modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/FastURLEncoder.java modules/common/trunk/common/src/main/java/org/jboss/portal/common/util/ParameterValidation.java modules/common/trunk/common/src/test/java/org/jboss/portal/test/common/text/CharBufferTestCase.java modules/common/trunk/common/src/test/java/org/jboss/portal/test/common/text/EntityEncoderTestCase.java Log: - Fixed CharBuffer.appendNoCheck method which was incorrect for case where offset was not 0. - Refactored CharEncoder hierachy: + Simplified AbstractCharEncoder. + Added String encode(String) method on CharEncoder. + FastURLDecoder and FastURLEncoder now extends AbstractCharEncoder. + JBPORTAL-1970: Improved exception messages by using ParameterValidation where possible. - Added ParameterValidation.throwIllegalArgExceptionIfRangeInvalid to check range. - Added test cases. Modified: modules/common/trunk/common/src/main/java/org/jboss/portal/common/io/WriterCharWriter.java =================================================================== --- modules/common/trunk/common/src/main/java/org/jboss/portal/common/io/WriterCharWriter.java 2008-04-21 23:09:28 UTC (rev 10688) +++ modules/common/trunk/common/src/main/java/org/jboss/portal/common/io/WriterCharWriter.java 2008-04-22 05:39:57 UTC (rev 10689) @@ -23,10 +23,10 @@ package org.jboss.portal.common.io; import org.jboss.portal.common.text.CharWriter; -import org.jboss.portal.common.io.UndeclaredIOException; +import org.jboss.portal.common.util.ParameterValidation; -import java.io.Writer; import java.io.IOException; +import java.io.Writer; /** * @author <a href="mailto:julien@jboss.org">Julien Viet</a> @@ -39,15 +39,12 @@ private final Writer writer; /** - * @param writer the target writer + * @param writer the target writer * @throws IllegalArgumentException if the writer is null */ public WriterCharWriter(Writer writer) throws IllegalArgumentException { - if (writer == null) - { - throw new IllegalArgumentException("No null writer accepted"); - } + ParameterValidation.throwIllegalArgExceptionIfNull(writer, "Writer"); this.writer = writer; } @@ -66,22 +63,8 @@ public CharWriter append(char[] chars, int off, int len) throws UndeclaredIOException { - if (chars == null) - { - throw new IllegalArgumentException(); - } - if (off < 0) - { - throw new IllegalArgumentException(); - } - if (len < 0) - { - throw new IllegalArgumentException(); - } - if (off + len > chars.length) - { - throw new IllegalArgumentException(); - } + ParameterValidation.throwIllegalArgExceptionIfRangeInvalid(chars, off, len); + try { writer.write(chars, off, len); @@ -95,10 +78,7 @@ public CharWriter append(char[] chars) throws UndeclaredIOException { - if (chars == null) - { - throw new IllegalArgumentException(); - } + ParameterValidation.throwIllegalArgExceptionIfNull(chars, "char[]"); try { writer.write(chars, 0, chars.length); @@ -112,10 +92,7 @@ public CharWriter append(CharSequence s) throws UndeclaredIOException { - if (s == null) - { - throw new IllegalArgumentException(); - } + ParameterValidation.throwIllegalArgExceptionIfNull(s, "CharSequence"); try { if (s instanceof String) @@ -124,7 +101,7 @@ } else { - for (int i = 0;i < s.length();i++) + for (int i = 0; i < s.length(); i++) { char c = s.charAt(i); writer.write(c); Modified: modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/AbstractCharEncoder.java =================================================================== --- modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/AbstractCharEncoder.java 2008-04-21 23:09:28 UTC (rev 10688) +++ modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/AbstractCharEncoder.java 2008-04-22 05:39:57 UTC (rev 10689) @@ -22,6 +22,12 @@ ******************************************************************************/ package org.jboss.portal.common.text; +import org.jboss.portal.common.io.WriterCharWriter; +import org.jboss.portal.common.util.ParameterValidation; + +import java.io.StringWriter; +import java.io.Writer; + /** * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 1.1 $ @@ -31,88 +37,56 @@ public void encode(char[] chars, int off, int len, CharWriter writer) throws EncodingException { - if (chars == null) - { - throw new IllegalArgumentException(); - } - if (writer == null) - { - throw new IllegalArgumentException(); - } - if (off < 0) - { - throw new IllegalArgumentException(); - } - if (off + len > chars.length) - { - throw new IllegalArgumentException(); - } + ParameterValidation.throwIllegalArgExceptionIfRangeInvalid(chars, off, len); + ParameterValidation.throwIllegalArgExceptionIfNull(writer, "CharWriter"); + // safeEncode(chars, off, len, writer); } public void encode(char[] chars, CharWriter writer) throws EncodingException { - if (chars == null) - { - throw new IllegalArgumentException(); - } - if (writer == null) - { - throw new IllegalArgumentException(); - } - - // - safeEncode(chars, writer); + ParameterValidation.throwIllegalArgExceptionIfNull(chars, "char[]"); + encode(chars, 0, chars.length, writer); } public void encode(CharSequence s, CharWriter writer) throws EncodingException { - if (s == null) + ParameterValidation.throwIllegalArgExceptionIfNull(s, "CharSequence"); + + // + if (s instanceof String) { - throw new IllegalArgumentException(); + char[] chars = ((String)s).toCharArray(); + encode(chars, 0, chars.length, writer); } - if (writer == null) + else { - throw new IllegalArgumentException(); + char[] chars = new char[s.length()]; + for (int i = 0; i < s.length(); i++) + { + char c = s.charAt(i); + chars[i] = c; + } + encode(chars, 0, chars.length, writer); } - - // - safeEncode(s, writer); } public void encode(char c, CharWriter writer) throws EncodingException { - if (writer == null) - { - throw new IllegalArgumentException(); - } - - // - safeEncode(c, writer); + encode(new char[]{c}, writer); } - protected void safeEncode(char[] chars, int off, int len, CharWriter writer) throws EncodingException + public String encode(String string) throws IllegalArgumentException { - for (int i = off;i < len;i++) - { - safeEncode(chars[i], writer); - } - } + ParameterValidation.throwIllegalArgExceptionIfNull(string, "String"); - protected void safeEncode(char[] chars, CharWriter writer) throws EncodingException - { - safeEncode(chars, 0, chars.length, writer); + Writer sw = new StringWriter(); + CharWriter charWriter = new WriterCharWriter(sw); + safeEncode(string.toCharArray(), 0, string.length(), charWriter); + return sw.toString(); } - protected void safeEncode(CharSequence s, CharWriter writer) throws EncodingException - { - for (int i = 0;i < s.length();i++) - { - safeEncode(s.charAt(i), writer); - } - } - - protected abstract void safeEncode(char c, CharWriter writer) throws EncodingException; + protected abstract void safeEncode(char[] chars, int off, int len, CharWriter writer) throws EncodingException; } Modified: modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/CharBuffer.java =================================================================== --- modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/CharBuffer.java 2008-04-21 23:09:28 UTC (rev 10688) +++ modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/CharBuffer.java 2008-04-22 05:39:57 UTC (rev 10689) @@ -22,6 +22,8 @@ ******************************************************************************/ package org.jboss.portal.common.text; +import org.jboss.portal.common.util.ParameterValidation; + /** * A simple char buffer that implements the <code>CharWriter</code> interface * @@ -38,7 +40,6 @@ protected int length; /** - * * @param size the initial size * @throws IllegalArgumentException if the initial size is not a positive value. */ @@ -46,7 +47,7 @@ { if (size < 0) { - throw new IllegalArgumentException(); + throw new IllegalArgumentException("Size must be positive!"); } this.buffer = new char[size]; this.length = 0; @@ -60,42 +61,22 @@ public CharBuffer append(String s, CharEncoder encoder) { - if (s == null) - { - throw new IllegalArgumentException(); - } - if (encoder == null) - { - throw new IllegalArgumentException(); - } + ParameterValidation.throwIllegalArgExceptionIfNull(s, "String"); + ParameterValidation.throwIllegalArgExceptionIfNull(encoder, "CharEncoder"); encoder.encode(s, this); return this; } public CharWriter append(CharSequence s) { - if (s == null) - { - throw new IllegalArgumentException(); - } + ParameterValidation.throwIllegalArgExceptionIfNull(s, "CharSequence"); appendNoCheck(s); return this; } public CharWriter append(char[] chars, int off, int len) { - if (chars == null) - { - throw new IllegalArgumentException(); - } - if (off < 0) - { - throw new IllegalArgumentException(); - } - if (off + len > chars.length) - { - throw new IllegalArgumentException(); - } + ParameterValidation.throwIllegalArgExceptionIfRangeInvalid(chars, off, len); // appendNoCheck(chars, off, len); @@ -118,10 +99,7 @@ public CharWriter append(char[] chars) { - if (chars == null) - { - throw new IllegalArgumentException(); - } + ParameterValidation.throwIllegalArgExceptionIfNull(chars, "char[]"); // appendNoCheck(chars, 0, chars.length); @@ -159,7 +137,7 @@ { if (length < 0) { - throw new IllegalArgumentException(); + throw new IllegalArgumentException("Length must be positive!"); } // @@ -184,7 +162,8 @@ ensureCapacity(length + len); if (len < 10) { - while (off < len) + int toCopy = off + len; + while (off < toCopy) { buffer[length++] = chars[off++]; } @@ -208,7 +187,7 @@ } else { - for (int i = 0;i < s.length();i++) + for (int i = 0; i < s.length(); i++) { char c = s.charAt(i); buffer[length++] = c; Modified: modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/CharEncoder.java =================================================================== --- modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/CharEncoder.java 2008-04-21 23:09:28 UTC (rev 10688) +++ modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/CharEncoder.java 2008-04-22 05:39:57 UTC (rev 10689) @@ -31,40 +31,43 @@ public interface CharEncoder { /** - * - * @param c the char to encode + * @param c the char to encode * @param writer the writer to use * @throws IllegalArgumentException if any argument is null - * @throws EncodingException an encoding exception + * @throws EncodingException an encoding exception */ void encode(char c, CharWriter writer) throws IllegalArgumentException, EncodingException; /** - * - * @param chars the chars to encode - * @param off the offset in the char array - * @param len the lenght of chars to encode + * @param chars the chars to encode + * @param off the offset in the char array + * @param len the lenght of chars to encode * @param writer the writer to use * @throws IllegalArgumentException if any argument is null or if the bounds not valid in the provided array - * @throws EncodingException an encoding exception + * @throws EncodingException an encoding exception */ void encode(char[] chars, int off, int len, CharWriter writer) throws IllegalArgumentException, EncodingException; /** - * - * @param chars the chars to encode + * @param chars the chars to encode * @param writer the writer to use * @throws IllegalArgumentException if any argument is null - * @throws EncodingException an encoding exception + * @throws EncodingException an encoding exception */ void encode(char[] chars, CharWriter writer) throws IllegalArgumentException, EncodingException; /** - * - * @param s the sequence to encode + * @param s the sequence to encode * @param writer the writer to use * @throws IllegalArgumentException if any argument is null - * @throws EncodingException an encoding exception + * @throws EncodingException an encoding exception */ void encode(CharSequence s, CharWriter writer) throws IllegalArgumentException, EncodingException; + + /** + * @param string the String to encode + * @return the encoded String + * @throws IllegalArgumentException if the specified String is <code>null</code> + */ + String encode(String string) throws IllegalArgumentException; } Modified: modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/EntityEncoder.java =================================================================== --- modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/EntityEncoder.java 2008-04-21 23:09:28 UTC (rev 10688) +++ modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/EntityEncoder.java 2008-04-22 05:39:57 UTC (rev 10689) @@ -22,6 +22,8 @@ ******************************************************************************/ package org.jboss.portal.common.text; +import org.jboss.portal.common.util.ParameterValidation; + /** * This encoder performs lookup for converting a char to its HTML entity representation. * @@ -31,8 +33,10 @@ public class EntityEncoder extends AbstractCharEncoder { - protected void safeEncode(char c, CharWriter writer) throws EncodingException + public void encode(char c, CharWriter writer) throws EncodingException { + ParameterValidation.throwIllegalArgExceptionIfNull(writer, "CharWriter"); + String s = charToEntity[c]; // Modified: modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/FastURLDecoder.java =================================================================== --- modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/FastURLDecoder.java 2008-04-21 23:09:28 UTC (rev 10688) +++ modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/FastURLDecoder.java 2008-04-22 05:39:57 UTC (rev 10689) @@ -22,16 +22,11 @@ ******************************************************************************/ package org.jboss.portal.common.text; -import java.io.StringWriter; -import java.io.Writer; - -import org.jboss.portal.common.io.WriterCharWriter; - /** * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 1.1 $ */ -public class FastURLDecoder implements CharEncoder +public class FastURLDecoder extends AbstractCharEncoder { /** . */ @@ -165,98 +160,9 @@ } } - public void encode(char c, CharWriter writer) - { - encode(new char[]{c}, writer); - } - public void encode(char[] chars, int off, int len, CharWriter writer) + protected void safeEncode(char[] chars, int i, int length, CharWriter tmp) { - if (chars == null) - { - throw new IllegalArgumentException(); - } - if (off < 0) - { - throw new IllegalArgumentException(); - } - if (len < 0) - { - throw new IllegalArgumentException(); - } - if (off + len > chars.length) - { - throw new IllegalArgumentException(); - } - if (writer == null) - { - throw new IllegalArgumentException(); - } - - // - encodeNoCheck(chars, off, len, writer); - } - - public void encode(char[] chars, CharWriter writer) - { - if (chars == null) - { - throw new IllegalArgumentException(); - } - if (writer == null) - { - throw new IllegalArgumentException(); - } - - // - encodeNoCheck(chars, 0, chars.length, writer); - } - - public void encode(CharSequence s, CharWriter writer) - { - if (s == null) - { - throw new IllegalArgumentException(); - } - if (writer == null) - { - throw new IllegalArgumentException(); - } - - // - if (s instanceof String) - { - char[] chars = ((String)s).toCharArray(); - encodeNoCheck(chars, 0, chars.length, writer); - } - else - { - char[] chars = new char[s.length()]; - for (int i = 0; i < s.length(); i++) - { - char c = s.charAt(i); - chars[i] = c; - } - encodeNoCheck(chars, 0, chars.length, writer); - } - } - - /** - * @param s - * @return - * @throws IllegalArgumentException - * @since 1.1 - */ - public String encode(String s) throws IllegalArgumentException - { - Writer sw = new StringWriter(); - CharWriter charWriter = new WriterCharWriter(sw); - encodeNoCheck(s.toCharArray(), 0, s.length(), charWriter); - return sw.toString(); - } - - private void encodeNoCheck(char[] chars, int i, int length, CharWriter tmp) - { while (i < length) { char c = chars[i++]; @@ -326,7 +232,7 @@ case ERROR: if (strict) { - throw new MalformedInputException("Cannot decode char " + c); + throw new MalformedInputException("Cannot decode char '" + c + "'"); } else { Modified: modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/FastURLEncoder.java =================================================================== --- modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/FastURLEncoder.java 2008-04-21 23:09:28 UTC (rev 10688) +++ modules/common/trunk/common/src/main/java/org/jboss/portal/common/text/FastURLEncoder.java 2008-04-22 05:39:57 UTC (rev 10689) @@ -23,6 +23,7 @@ package org.jboss.portal.common.text; import org.jboss.portal.common.io.UndeclaredIOException; +import org.jboss.portal.common.util.ParameterValidation; import java.io.IOException; import java.io.Writer; @@ -33,7 +34,7 @@ * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 7228 $ */ -public class FastURLEncoder implements CharEncoder +public class FastURLEncoder extends AbstractCharEncoder { /** . */ @@ -106,151 +107,46 @@ } } - public void encode(CharSequence s, CharWriter out) throws IllegalArgumentException + public void encode(char c, CharWriter writer) { - if (s == null) - { - throw new IllegalArgumentException(); - } - if (out == null) - { - throw new IllegalArgumentException(); - } + ParameterValidation.throwIllegalArgExceptionIfNull(writer, "CharWriter"); // - for (int i = 0; i < s.length(); i++) - { - char c = s.charAt(i); - char[] z = table[c]; - if (z == null) - { - throw new MalformedInputException("Wrong"); - } - out.append(z); - } + char[] z = getEncoding(c); + writer.append(z); } - public void encode(char c, CharWriter writer) + private char[] getEncoding(char c) { - if (writer == null) - { - throw new IllegalArgumentException(); - } - - // char[] z = table[c]; if (z == null) { - throw new MalformedInputException("Wrong"); + throw new MalformedInputException("Couldn't find appropriate encoding for '" + c + "'"); } - writer.append(z); + return z; } - public void encode(char[] chars, int off, int len, CharWriter writer) + protected void safeEncode(char[] chars, int off, int len, CharWriter writer) { - if (chars == null) - { - throw new IllegalArgumentException(); - } - if (off < 0) - { - throw new IllegalArgumentException(); - } - if (len < 0) - { - throw new IllegalArgumentException(); - } - if (off + len > chars.length) - { - throw new IllegalArgumentException(); - } - if (writer == null) - { - throw new IllegalArgumentException(); - } - - // - encodeNoCheck(chars, off, len, writer); - } - - public void encode(char[] chars, CharWriter writer) - { - if (chars == null) - { - throw new IllegalArgumentException(); - } - if (writer == null) - { - throw new IllegalArgumentException(); - } - - // - encodeNoCheck(chars, 0, chars.length, writer); - } - - private void encodeNoCheck(char[] chars, int off, int len, CharWriter writer) - { for (int i = off; i < len; i++) { char c = chars[i]; - char[] z = table[c]; - if (z == null) - { - throw new IllegalArgumentException("Wrong"); - } + char[] z = getEncoding(c); writer.append(z); } } - public String encode(String s) throws IllegalArgumentException - { - StringBuffer tmp = new StringBuffer(); - encode(s, tmp); - return tmp.toString(); - } - - public void encode(String s, StringBuffer out) throws IllegalArgumentException - { - if (s == null) - { - throw new IllegalArgumentException(); - } - if (out == null) - { - throw new IllegalArgumentException(); - } - for (int i = 0; i < s.length(); i++) - { - char c = s.charAt(i); - char[] z = table[c]; - if (z == null) - { - throw new MalformedInputException("Cannot encode char=" + (int)c); - } - out.append(z); - } - } - public void encode(String s, Writer out) throws IllegalArgumentException, UndeclaredIOException { - if (s == null) - { - throw new IllegalArgumentException(); - } - if (out == null) - { - throw new IllegalArgumentException(); - } + ParameterValidation.throwIllegalArgExceptionIfNull(s, "String"); + ParameterValidation.throwIllegalArgExceptionIfNull(out, "Writer"); + try { for (int i = 0; i < s.length(); i++) { char c = s.charAt(i); - char[] z = table[c]; - if (z == null) - { - throw new MalformedInputException("Wrong"); - } + char[] z = getEncoding(c); out.write(z); } } Modified: modules/common/trunk/common/src/main/java/org/jboss/portal/common/util/ParameterValidation.java =================================================================== --- modules/common/trunk/common/src/main/java/org/jboss/portal/common/util/ParameterValidation.java 2008-04-21 23:09:28 UTC (rev 10688) +++ modules/common/trunk/common/src/main/java/org/jboss/portal/common/util/ParameterValidation.java 2008-04-22 05:39:57 UTC (rev 10689) @@ -37,6 +37,24 @@ } } + public static void throwIllegalArgExceptionIfRangeInvalid(char[] chars, int offset, int length) + { + ParameterValidation.throwIllegalArgExceptionIfNull(chars, "characters"); + + if (offset < 0) + { + throw new IllegalArgumentException("Offset must be positive!"); + } + if (length < 0) + { + throw new IllegalArgumentException("Length must be positive!"); + } + if (offset + length > chars.length) + { + throw new IllegalArgumentException("Specified character range is outside of the given char[]!"); + } + } + /** @since 2.6 */ public static boolean isNullOrEmpty(String valueToCheck) { Modified: modules/common/trunk/common/src/test/java/org/jboss/portal/test/common/text/CharBufferTestCase.java =================================================================== --- modules/common/trunk/common/src/test/java/org/jboss/portal/test/common/text/CharBufferTestCase.java 2008-04-21 23:09:28 UTC (rev 10688) +++ modules/common/trunk/common/src/test/java/org/jboss/portal/test/common/text/CharBufferTestCase.java 2008-04-22 05:39:57 UTC (rev 10689) @@ -63,6 +63,15 @@ assertEquals("abc", buffer.asString()); } + public void testCharArrayAppendWithOffset() + { + CharBuffer buffer = new CharBuffer(); + buffer.append("abcdef".toCharArray(), 1, 5); + assertEquals("bcdef", buffer.asString()); + buffer.append("pqrstu".toCharArray(), 3, 3); + assertEquals("stu", buffer.asString()); + } + public void testReset() { CharBuffer buffer = new CharBuffer(0); Modified: modules/common/trunk/common/src/test/java/org/jboss/portal/test/common/text/EntityEncoderTestCase.java =================================================================== --- modules/common/trunk/common/src/test/java/org/jboss/portal/test/common/text/EntityEncoderTestCase.java 2008-04-21 23:09:28 UTC (rev 10688) +++ modules/common/trunk/common/src/test/java/org/jboss/portal/test/common/text/EntityEncoderTestCase.java 2008-04-22 05:39:57 UTC (rev 10689) @@ -23,8 +23,8 @@ package org.jboss.portal.test.common.text; import junit.framework.TestCase; +import org.jboss.portal.common.text.CharBuffer; import org.jboss.portal.common.text.EntityEncoder; -import org.jboss.portal.common.text.CharBuffer; /** * @author <a href="mailto:julien@jboss.org">Julien Viet</a> @@ -42,6 +42,13 @@ assertEquals("c", buffer.asString(true)); } + public void testChars() + { + CharBuffer buffer = new CharBuffer(); + EntityEncoder.FULL.encode("&bar".toCharArray(), buffer); + assertEquals("&amp;bar", buffer.asString(true)); + } + public void testString() { test("&amp;", "&");