Merge pull request #3186 from dizzzz/feature/faststrngbuffer_update

FastStringBuffer improvement

Author: adamretter

exist-core/src/main/java/org/exist/util/FastStringBuffer.java

@@ -7,23 +7,25 @@
  * modify it under the terms of the GNU Lesser General Public License
  * as published by the Free Software Foundation; either version 2
  * of the License, or (at your option) any later version.
- *  
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Lesser General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU Lesser General Public License
  * along with this program; if not, write to the Free Software Foundation
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
  * This class is to large extents copied from Saxon 2003-01-21 (version ?).
  * See comment at the back about licensing for those parts.
- * 
+ *
  *  $Id$
  */
 package org.exist.util;
 
+import org.apache.commons.lang3.StringUtils;
+
 import java.io.Serializable;
 import java.io.Writer;
 
@@ -36,12 +38,17 @@
 
 public final class FastStringBuffer implements CharSequence, Serializable {
 
-	private static final long serialVersionUID = -504264698052799896L;
+    private static final long serialVersionUID = -504264698052799896L;
 
-	private char[] array;
+    private char[] array;
     private int used = 0;
 
-    public FastStringBuffer(int initialSize) {
+    /**
+     * Create a FastStringBuffer with a given initial capacity
+     * @param initialSize the initial capacity
+     */
+
+    public FastStringBuffer(final int initialSize) {
         array = new char[initialSize];
     }
 
@@ -50,8 +57,8 @@ public FastStringBuffer(int initialSize) {
      * @param s the String to be appended
      */
 
-    public void append(String s) {
-        int len = s.length();
+    public void append(final String s) {
+        final int len = s.length();
         ensureCapacity(len);
         s.getChars(0, len, array, used);
         used += len;
@@ -62,8 +69,8 @@ public void append(String s) {
      * @param s the String to be appended
      */
 
-    public void append(CharSlice s) {
-        int len = s.length();
+    public void append(final CharSlice s) {
+        final int len = s.length();
         ensureCapacity(len);
         s.copyTo(array, used);
         used += len;
@@ -74,8 +81,8 @@ public void append(CharSlice s) {
      * @param s the FastStringBuffer to be appended
      */
 
-    public void append(FastStringBuffer s) {
-        int len = s.length();
+    public void append(final FastStringBuffer s) {
+        final int len = s.length();
         ensureCapacity(len);
         s.getChars(0, len, array, used);
         used += len;
@@ -86,8 +93,8 @@ public void append(FastStringBuffer s) {
      * @param s the StringBuffer to be appended
      */
 
-    public void append(StringBuffer s) {
-        int len = s.length();
+    public void append(final StringBuilder s) {
+        final int len = s.length();
         ensureCapacity(len);
         s.getChars(0, len, array, used);
         used += len;
@@ -98,7 +105,7 @@ public void append(StringBuffer s) {
      * @param s the CharSequence to be appended
      */
 
-    public void append(CharSequence s) {
+    public void append(final CharSequence s) {
         // Although we provide variants of this method for different subtypes, Java decides which to use based
         // on the static type of the operand. We want to use the right method based on the dynamic type, to avoid
         // creating objects and copying strings unnecessarily. So we do a dynamic dispatch.
@@ -126,7 +133,7 @@ public void append(CharSequence s) {
      * @param length the number of characters to be copied
      */
 
-    public void append(char[] srcArray, int start, int length) {
+    public void append(final char[] srcArray, final int start, final int length) {
         ensureCapacity(length);
         System.arraycopy(srcArray, start, array, used, length);
         used += length;
@@ -137,7 +144,7 @@ public void append(char[] srcArray, int start, int length) {
      * @param srcArray the array whose contents are to be added
      */
 
-    public void append(char[] srcArray) {
+    public void append(final char[] srcArray) {
         final int length = srcArray.length;
         ensureCapacity(length);
         System.arraycopy(srcArray, 0, array, used, length);
@@ -149,7 +156,7 @@ public void append(char[] srcArray) {
      * @param ch the character to be added
      */
 
-    public void append(char ch) {
+    public void append(final char ch) {
         ensureCapacity(1);
         array[used++] = ch;
     }
@@ -173,7 +180,7 @@ public void appendWideChar(final int ch) {
      *
      * @param ch the character
      */
-    public void prependWideChar(int ch) {
+    public void prependWideChar(final int ch) {
         if (ch > 0xffff) {
             insertCharAt(0, XMLChar.lowSurrogate(ch));
             insertCharAt(0, XMLChar.highSurrogate(ch));
@@ -207,7 +214,7 @@ public int length() {
      * @throws IndexOutOfBoundsException if the <code>index</code> argument is negative or not less than
      *                                   <code>length()</code>
      */
-    public char charAt(int index) {
+    public char charAt(final int index) {
         if (index >= used) {
             throw new IndexOutOfBoundsException("" + index);
         }
@@ -229,7 +236,7 @@ public char charAt(int index) {
      *                                   if <code>end</code> is greater than <code>length()</code>,
      *                                   or if <code>start</code> is greater than <code>end</code>
      */
-    public CharSequence subSequence(int start, int end) {
+    public CharSequence subSequence(final int start, final int end) {
         return new CharSlice(array, start, end - start);
     }
 
@@ -263,7 +270,7 @@ public CharSequence subSequence(int start, int end) {
      *            <li><code>dstBegin+(srcEnd-srcBegin)</code> is larger than
      *                <code>dst.length</code></ul>
      */
-    public void getChars(int srcBegin, int srcEnd, char dst[], int dstBegin) {
+    public void getChars(final int srcBegin, final int srcEnd, final char[] dst, final int dstBegin) {
         if (srcBegin < 0) {
             throw new StringIndexOutOfBoundsException(srcBegin);
         }
@@ -281,7 +288,7 @@ public void getChars(int srcBegin, int srcEnd, char dst[], int dstBegin) {
      * @param ch the character to search for
      * @return the position of the first occurrence, or -1 if not found
      */
-    public int indexOf(char ch) {
+    public int indexOf(final char ch) {
         for (int i=0; i<used; i++) {
             if (array[i] == ch) {
                 return i;
@@ -304,7 +311,7 @@ public String toString() {
      * @param ch the new character to overwrite the existing character at that location
      * @throws IndexOutOfBoundsException if {@code int < 0 || int >= length()}
      */
-    public void setCharAt(int index, char ch) {
+    public void setCharAt(final int index, final char ch) {
         if (index<0 || index>used) {
             throw new IndexOutOfBoundsException(""+index);
         }
@@ -317,14 +324,12 @@ public void setCharAt(int index, char ch) {
      * @param ch the new character to insert at that location
      * @throws IndexOutOfBoundsException if {@code int < 0 || int >= length()}
      */
-    public void insertCharAt(int index, char ch) {
+    public void insertCharAt(final int index, final char ch) {
         if (index<0 || index>used) {
             throw new IndexOutOfBoundsException(""+index);
         }
         ensureCapacity(1);
-        for (int i=used; i>index; i--) {
-            array[i] = array[i-1];
-        }
+        System.arraycopy(array, index, array, index + 1, used - index);
         used++;
         array[index] = ch;
     }
@@ -334,14 +339,12 @@ public void insertCharAt(int index, char ch) {
      * @param index the index of the character to be set
      * @throws IndexOutOfBoundsException if {@code int < 0 || int >= length()}
      */
-    public void removeCharAt(int index) {
+    public void removeCharAt(final int index) {
         if (index<0 || index>used) {
             throw new IndexOutOfBoundsException(""+index);
         }
         used--;
-        for (int i=index; i<used; i++) {
-            array[i] = array[i+1];
-        }
+        System.arraycopy(array, index + 1, array, index, used - index);
     }
 
     /**
@@ -351,7 +354,7 @@ public void removeCharAt(int index) {
      *
      * @param length the new length
      */
-    public void setLength(int length) {
+    public void setLength(final int length) {
         if (length < 0 || length > used) {
             return;
         }
@@ -363,13 +366,13 @@ public void setLength(int length) {
      *
      * @param extra the extra capacity needed.
      */
-    public void ensureCapacity(int extra) {
+    public void ensureCapacity(final int extra) {
         if (used + extra > array.length) {
             int newlen = array.length * 2;
             if (newlen < used + extra) {
                 newlen = used + extra*2;
             }
-            char[] array2 = new char[newlen];
+            final char[] array2 = new char[newlen];
             System.arraycopy(array, 0, array2, 0, used);
             array = array2;
         }
@@ -385,7 +388,7 @@ public void ensureCapacity(int extra) {
      */
     public CharSequence condense() {
         if (array.length - used > 256 || array.length > used * 2) {
-            char[] array2 = new char[used];
+            final char[] array2 = new char[used];
             System.arraycopy(array, 0, array2, 0, used);
             array = array2;
         }
@@ -410,7 +413,7 @@ public void write(final Writer writer) throws java.io.IOException {
      *
      * @return the diagnostic print
      */
-    public static String diagnosticPrint(CharSequence in) {
+    public static String diagnosticPrint(final CharSequence in) {
         final FastStringBuffer buff = new FastStringBuffer(in.length()*2);
         for (int i=0; i<in.length(); i++) {
             final char c = in.charAt(i);
@@ -425,9 +428,9 @@ public static String diagnosticPrint(CharSequence in) {
         }
         return buff.toString();
     }
-    
+
     //Quick copies from old eXist's FastStringBuffer
-  
+
     /**
      *  Manefest constant: Suppress leading whitespace. This should be used when
      *  normalize-to-SAX is called for the first chunk of a multi-chunk output,
@@ -451,32 +454,35 @@ public static String diagnosticPrint(CharSequence in) {
      *
      * see    sendNormalizedSAXcharacters(char[],int,int,org.xml.sax.ContentHandler,int)
      */
-    public final static int SUPPRESS_BOTH
-             = SUPPRESS_LEADING_WS | SUPPRESS_TRAILING_WS;
-   
+    public final static int SUPPRESS_BOTH = SUPPRESS_LEADING_WS | SUPPRESS_TRAILING_WS;
+
     /**
      *  Gets the normalizedString attribute of the FastStringBuffer object
      *
-     *@param  mode  Description of the Parameter
+     *@param  mode  Trim mode
      *@return       The normalizedString value
      */
-    public String getNormalizedString( int mode ) {
-        return getNormalizedString( new StringBuffer(toString()), mode ).toString();
+    public String getNormalizedString(final int mode ) {
+
+        switch(mode){
+            case SUPPRESS_BOTH:
+                return toString().trim();
+
+            case SUPPRESS_LEADING_WS:
+                return StringUtils.stripStart(toString(),null);
+
+            case SUPPRESS_TRAILING_WS:
+                return StringUtils.stripEnd(toString(),null);
+
+            default:
+                return toString().trim();
+        }
+
     }
 
 
-    /**
-     *  Gets the normalizedString attribute of the FastStringBuffer object
-     *
-     *@param  sb    Description of the Parameter
-     *@param  mode  Description of the Parameter
-     *@return       The normalizedString value
-     */    
-    public StringBuffer getNormalizedString(StringBuffer sb, int mode ) {
-    	//TODO : switch (mode)
-    	return new StringBuffer(toString().trim());   	
-    }    
-    
+
+
 }
 
 //

exist-core/src/main/java/org/exist/xquery/value/DayTimeDurationValue.java

@@ -128,7 +128,7 @@ public String getStringValue() {
             //	sb.append(Double.toString(ms).substring(2));
             //}
             //0 is a dummy parameter
-            FloatingPointConverter.appendFloat(sb, s.floatValue()).getNormalizedString(0);
+            FloatingPointConverter.appendFloat(sb, s.floatValue()).getNormalizedString(FastStringBuffer.SUPPRESS_BOTH);
             sb.append("S");
             /*
             if (micros == 0) {

exist-core/src/main/java/org/exist/xquery/value/DoubleValue.java

@@ -75,7 +75,7 @@ public int getType() {
     public String getStringValue() {
         final FastStringBuffer sb = new FastStringBuffer(20);
         //0 is a dummy parameter
-        FloatingPointConverter.appendDouble(sb, value).getNormalizedString(0);
+        FloatingPointConverter.appendDouble(sb, value).getNormalizedString(FastStringBuffer.SUPPRESS_BOTH);
         return sb.toString();
     }
 

exist-core/src/main/java/org/exist/xquery/value/FloatValue.java

@@ -101,7 +101,7 @@ public String getStringValue() throws XPathException {
 
         final FastStringBuffer sb = new FastStringBuffer(20);
         //0 is a dummy parameter
-        FloatingPointConverter.appendFloat(sb, value).getNormalizedString(0);
+        FloatingPointConverter.appendFloat(sb, value).getNormalizedString(FastStringBuffer.SUPPRESS_BOTH);
         return sb.toString();
     }