Return-Path: X-Original-To: apmail-poi-commits-archive@minotaur.apache.org Delivered-To: apmail-poi-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 4BC0118CA8 for ; Thu, 7 Jan 2016 17:22:44 +0000 (UTC) Received: (qmail 86741 invoked by uid 500); 7 Jan 2016 17:22:44 -0000 Delivered-To: apmail-poi-commits-archive@poi.apache.org Received: (qmail 86704 invoked by uid 500); 7 Jan 2016 17:22:44 -0000 Mailing-List: contact commits-help@poi.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@poi.apache.org Delivered-To: mailing list commits@poi.apache.org Received: (qmail 86634 invoked by uid 99); 7 Jan 2016 17:22:44 -0000 Received: from Unknown (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 07 Jan 2016 17:22:44 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id 82C1918050E for ; Thu, 7 Jan 2016 17:22:43 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 1.247 X-Spam-Level: * X-Spam-Status: No, score=1.247 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, RP_MATCHES_RCVD=-0.554, URIBL_BLOCKED=0.001] autolearn=disabled Received: from mx1-us-west.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id TM8ZOEaY_iJ7 for ; Thu, 7 Jan 2016 17:22:04 +0000 (UTC) Received: from mailrelay1-us-west.apache.org (mailrelay1-us-west.apache.org [209.188.14.139]) by mx1-us-west.apache.org (ASF Mail Server at mx1-us-west.apache.org) with ESMTP id 78ED3231A6 for ; Thu, 7 Jan 2016 17:22:04 +0000 (UTC) Received: from svn01-us-west.apache.org (svn.apache.org [10.41.0.6]) by mailrelay1-us-west.apache.org (ASF Mail Server at mailrelay1-us-west.apache.org) with ESMTP id 0991AE4896 for ; Thu, 7 Jan 2016 17:22:03 +0000 (UTC) Received: from svn01-us-west.apache.org (localhost [127.0.0.1]) by svn01-us-west.apache.org (ASF Mail Server at svn01-us-west.apache.org) with ESMTP id 081763A2539 for ; Thu, 7 Jan 2016 17:22:03 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1723598 [22/42] - in /poi/site/publish/apidocs/org/apache/poi/util: ./ class-use/ Date: Thu, 07 Jan 2016 17:22:00 -0000 To: commits@poi.apache.org From: nick@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20160107172203.081763A2539@svn01-us-west.apache.org> Modified: poi/site/publish/apidocs/org/apache/poi/util/StringUtil.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/util/StringUtil.html?rev=1723598&r1=1723597&r2=1723598&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/util/StringUtil.html (original) +++ poi/site/publish/apidocs/org/apache/poi/util/StringUtil.html Thu Jan 7 17:21:59 2016 @@ -1,548 +1,477 @@ - - - - -StringUtil (POI API Documentation) - - - - - - - - - - - -
- - +//--> + + - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- + + +
+ + +
+ + + - -
-

- -org.apache.poi.util -
-Class StringUtil

-
-java.lang.Object
-  extended by org.apache.poi.util.StringUtil
-
-
-
-
public class StringUtil
extends java.lang.Object
- - -

-Title: String Utility Description: Collection of string handling utilities

- - Note - none of the methods in this class deals with ContinueRecords. - For such functionality, consider using RecordInputStream -

- -

-

- -

+

+
org.apache.poi.util
+

Class StringUtil

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.apache.poi.util.StringUtil
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class StringUtil
+extends java.lang.Object
    +
    Title: String Utility Description: Collection of string handling utilities

    + + Note - none of the methods in this class deals with ContinueRecords. + For such functionality, consider using RecordInputStream

    +
    • +
+
+
+
    +
  • - - - - - - - - - - -
    -Nested Class Summary
    -static classStringUtil.StringsIterator - -
    -          An Iterator over an array of Strings.
    -  - - - - - - - - - - - - - - - - - - -
    -Field Summary
    -protected static java.nio.charset.CharsetISO_8859_1 - -
    -           
    -protected static java.nio.charset.CharsetUTF16LE - -
    -           
    -static java.nio.charset.CharsetUTF8 - -
    -           
    -  +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class StringUtil.StringsIterator +
      An Iterator over an array of Strings.
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected static java.nio.charset.CharsetISO_8859_1 
      protected static java.nio.charset.CharsetUTF16LE 
      static java.nio.charset.CharsetUTF8 
      +
      • +
    - - - - - - - - - - - - - - - - - - - - - + +
    -Method Summary
    -static java.lang.Stringformat(java.lang.String message, - java.lang.Object[] params) - -
    -          Apply printf() like formatting to a string.
    -static intgetEncodedSize(java.lang.String value) - -
    -           
    -static java.lang.StringgetFromCompressedUnicode(byte[] string, - int offset, - int len) - -
    -          Read 8 bit data (in ISO-8859-1 codepage) into a (unicode) Java - String and return.
    -static java.lang.StringgetFromUnicodeLE(byte[] string) - -
    -          Given a byte array of 16-bit unicode characters in little endian +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + - - - - + + + + - - - - + + + + - -
      Methods 
      Modifier and TypeMethod and Description
      static java.lang.Stringformat(java.lang.String message, + java.lang.Object[] params) +
      Apply printf() like formatting to a string.
      +
      static intgetEncodedSize(java.lang.String value) 
      static java.lang.StringgetFromCompressedUnicode(byte[] string, + int offset, + int len) +
      Read 8 bit data (in ISO-8859-1 codepage) into a (unicode) Java + String and return.
      +
      static java.lang.StringgetFromUnicodeLE(byte[] string) +
      Given a byte array of 16-bit unicode characters in little endian format (most important byte last), return a Java String representation - of it.
      -static java.lang.StringgetFromUnicodeLE(byte[] string, - int offset, - int len) - -
      -          Given a byte array of 16-bit unicode characters in Little Endian + of it. +
      static java.lang.StringgetFromUnicodeLE(byte[] string, + int offset, + int len) +
      Given a byte array of 16-bit unicode characters in Little Endian format (most important byte last), return a Java String representation - of it.
      -static java.lang.StringgetPreferredEncoding() - -
      -           
      -static byte[]getToUnicodeLE(java.lang.String string) - -
      -          Convert String to 16-bit unicode characters in little endian format
      -static booleanhasMultibyte(java.lang.String value) - -
      -          check the parameter has multibyte character
      -static booleanisUnicodeString(java.lang.String value) - -
      -          Checks to see if a given String needs to be represented as Unicode
      -static voidmapMsCodepoint(int msCodepoint, - int unicodeCodepoint) - -
      -           
      -static java.lang.StringmapMsCodepointString(java.lang.String string) - -
      -          Some strings may contain encoded characters of the unicode private use area.
      -static voidputCompressedUnicode(java.lang.String input, - byte[] output, - int offset) - -
      -          Takes a unicode (java) string, and returns it as 8 bit data (in ISO-8859-1 - codepage).
      -static voidputCompressedUnicode(java.lang.String input, - LittleEndianOutput out) - -
      -           
      -static voidputUnicodeLE(java.lang.String input, - byte[] output, - int offset) - -
      -          Takes a unicode string, and returns it as little endian (most - important byte last) bytes in the supplied byte array.
      -static voidputUnicodeLE(java.lang.String input, - LittleEndianOutput out) - -
      -           
      -static java.lang.StringreadCompressedUnicode(LittleEndianInput in, - int nChars) - -
      -           
      -static java.lang.StringreadUnicodeLE(LittleEndianInput in, - int nChars) - -
      -           
      -static java.lang.StringreadUnicodeString(LittleEndianInput in) - -
      -          InputStream in is expected to contain: + of it. +
      static java.lang.StringgetPreferredEncoding() 
      static byte[]getToUnicodeLE(java.lang.String string) +
      Convert String to 16-bit unicode characters in little endian format
      +
      static booleanhasMultibyte(java.lang.String value) +
      check the parameter has multibyte character
      +
      static booleanisUnicodeString(java.lang.String value) +
      Checks to see if a given String needs to be represented as Unicode
      +
      static voidmapMsCodepoint(int msCodepoint, + int unicodeCodepoint) 
      static java.lang.StringmapMsCodepointString(java.lang.String string) +
      Some strings may contain encoded characters of the unicode private use area.
      +
      static voidputCompressedUnicode(java.lang.String input, + byte[] output, + int offset) +
      Takes a unicode (java) string, and returns it as 8 bit data (in ISO-8859-1 + codepage).
      +
      static voidputCompressedUnicode(java.lang.String input, + LittleEndianOutput out) 
      static voidputUnicodeLE(java.lang.String input, + byte[] output, + int offset) +
      Takes a unicode string, and returns it as little endian (most + important byte last) bytes in the supplied byte array.
      +
      static voidputUnicodeLE(java.lang.String input, + LittleEndianOutput out) 
      static java.lang.StringreadCompressedUnicode(LittleEndianInput in, + int nChars) 
      static java.lang.StringreadUnicodeLE(LittleEndianInput in, + int nChars) 
      static java.lang.StringreadUnicodeString(LittleEndianInput in) +
      InputStream in is expected to contain: ushort nChars byte is16BitFlag byte[]/char[] characterData - For this encoding, the is16BitFlag is always present even if nChars==0.
      -static java.lang.StringreadUnicodeString(LittleEndianInput in, - int nChars) - -
      -          InputStream in is expected to contain: + For this encoding, the is16BitFlag is always present even if nChars==0. +
      static java.lang.StringreadUnicodeString(LittleEndianInput in, + int nChars) +
      InputStream in is expected to contain: byte is16BitFlag byte[]/char[] characterData - For this encoding, the is16BitFlag is always present even if nChars==0.
      -static voidwriteUnicodeString(LittleEndianOutput out, - java.lang.String value) - -
      -          OutputStream out will get: + For this encoding, the is16BitFlag is always present even if nChars==0. +
      static voidwriteUnicodeString(LittleEndianOutput out, + java.lang.String value) +
      OutputStream out will get: ushort nChars byte is16BitFlag byte[]/char[] characterData - For this encoding, the is16BitFlag is always present even if nChars==0.
      -static voidwriteUnicodeStringFlagAndData(LittleEndianOutput out, - java.lang.String value) - -
      -          OutputStream out will get: + For this encoding, the is16BitFlag is always present even if nChars==0. +
      static voidwriteUnicodeStringFlagAndData(LittleEndianOutput out, + java.lang.String value) +
      OutputStream out will get: byte is16BitFlag byte[]/char[] characterData - For this encoding, the is16BitFlag is always present even if nChars==0.
      -  - - - - - - - -
      Methods inherited from class java.lang.Object
      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      -  -

      - + For this encoding, the is16BitFlag is always present even if nChars==0. +

    +
      +
    • + + +

      Methods inherited from class java.lang.Object

      +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
    +
    • +
+ + +
+
+
    +
  • - - - - - - -
    -Field Detail
    - -

    -ISO_8859_1

    -
    -protected static final java.nio.charset.Charset ISO_8859_1
    -
    -
    -
    -
    -
    - -

    -UTF16LE

    -
    -protected static final java.nio.charset.Charset UTF16LE
    -
    -
    -
    -
    -
    - -

    -UTF8

    -
    -public static final java.nio.charset.Charset UTF8
    -
    -
    -
    -
    - +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ISO_8859_1

        +
        protected static final java.nio.charset.Charset ISO_8859_1
        +
        • +
      + + + +
        +
      • +

        UTF16LE

        +
        protected static final java.nio.charset.Charset UTF16LE
        +
        • +
      + + + +
        +
      • +

        UTF8

        +
        public static final java.nio.charset.Charset UTF8
        +
        • +
      +
      • +
    - - - - - - -
    -Method Detail
    - -

    -getFromUnicodeLE

    -
    -public static java.lang.String getFromUnicodeLE(byte[] string,
-                                                int offset,
-                                                int len)
+
      
+
    • 
+
+
+
      Method Detail
      
+
+
+
+
        
+
      • 
+
        getFromUnicodeLE
        
+
        public static java.lang.String getFromUnicodeLE(byte[] string,
+                                int offset,
+                                int len)
                                          throws java.lang.ArrayIndexOutOfBoundsException,
-                                                java.lang.IllegalArgumentException
        
-
        
-
        Given a byte array of 16-bit unicode characters in Little Endian
+                                                java.lang.IllegalArgumentException
    +
    Given a byte array of 16-bit unicode characters in Little Endian format (most important byte last), return a Java String representation of it. - { 0x16, 0x00 } -0x16 -

    -

    -
    Parameters:
    string - the byte array to be converted
    offset - the initial offset into the + { 0x16, 0x00 } -0x16
    +
    Parameters:
    string - the byte array to be converted
    offset - the initial offset into the byte array. it is assumed that string[ offset ] and string[ offset + - 1 ] contain the first 16-bit unicode character
    len - the length of the final string -
    Returns:
    the converted string, never null. -
    Throws: -
    java.lang.ArrayIndexOutOfBoundsException - if offset is out of bounds for + 1 ] contain the first 16-bit unicode character
    len - the length of the final string
    +
    Returns:
    the converted string, never null.
    +
    Throws:
    +
    java.lang.ArrayIndexOutOfBoundsException - if offset is out of bounds for the byte array (i.e., is negative or is greater than or equal to - string.length) -
    java.lang.IllegalArgumentException - if len is too large (i.e., + string.length)
    +
    java.lang.IllegalArgumentException - if len is too large (i.e., there is not enough data in string to create a String of that - length)
    - - -
    - -

    -getFromUnicodeLE

    -
    -public static java.lang.String getFromUnicodeLE(byte[] string)
    -
    -
    Given a byte array of 16-bit unicode characters in little endian + length)
    +
    • +
+ + + +
    +
  • +

    getFromUnicodeLE

    +
    public static java.lang.String getFromUnicodeLE(byte[] string)
    +
    Given a byte array of 16-bit unicode characters in little endian format (most important byte last), return a Java String representation of it. - { 0x16, 0x00 } -0x16 -

    -

    -
    Parameters:
    string - the byte array to be converted -
    Returns:
    the converted string, never null
    -
    - -
    - -

    -getToUnicodeLE

    -
    -public static byte[] getToUnicodeLE(java.lang.String string)
    -
    -
    Convert String to 16-bit unicode characters in little endian format -

    -

    -
    Parameters:
    string - the string -
    Returns:
    the byte array of 16-bit unicode characters
    -
    -
    -
    - -

    -getFromCompressedUnicode

    -
    -public static java.lang.String getFromCompressedUnicode(byte[] string,
-                                                        int offset,
-                                                        int len)
    -
    -
    Read 8 bit data (in ISO-8859-1 codepage) into a (unicode) Java + { 0x16, 0x00 } -0x16
    +
    Parameters:
    string - the byte array to be converted
    +
    Returns:
    the converted string, never null
    +
    • +
+ + + +
    +
  • +

    getToUnicodeLE

    +
    public static byte[] getToUnicodeLE(java.lang.String string)
    +
    Convert String to 16-bit unicode characters in little endian format
    +
    Parameters:
    string - the string
    +
    Returns:
    the byte array of 16-bit unicode characters
    +
    • +
+ + + +
    +
  • +

    getFromCompressedUnicode

    +
    public static java.lang.String getFromCompressedUnicode(byte[] string,
+                                        int offset,
+                                        int len)
    +
    Read 8 bit data (in ISO-8859-1 codepage) into a (unicode) Java String and return. - (In Excel terms, read compressed 8 bit unicode as a string) -

    -

    -
    Parameters:
    string - byte array to read
    offset - offset to read byte array
    len - length to read byte array -
    Returns:
    String generated String instance by reading byte array
    -
    - -
    - -

    -readCompressedUnicode

    -
    -public static java.lang.String readCompressedUnicode(LittleEndianInput in,
-                                                     int nChars)
    -
    -
    -
    -
    -
    -
    - -

    -readUnicodeString

    -
    -public static java.lang.String readUnicodeString(LittleEndianInput in)
    -
    -
    InputStream in is expected to contain: + (In Excel terms, read compressed 8 bit unicode as a string)
    +
    Parameters:
    string - byte array to read
    offset - offset to read byte array
    len - length to read byte array
    +
    Returns:
    String generated String instance by reading byte array
    +
    • +
+ + + +
    +
  • +

    readCompressedUnicode

    +
    public static java.lang.String readCompressedUnicode(LittleEndianInput in,
+                                     int nChars)
    +
    • +
+ + + +
    +
  • +

    readUnicodeString

    +
    public static java.lang.String readUnicodeString(LittleEndianInput in)
    +
    InputStream in is expected to contain:
    1. ushort nChars
    2. byte is16BitFlag
      3. @@ -550,21 +479,18 @@ public static java.lang.String readUn
    For this encoding, the is16BitFlag is always present even if nChars==0. - This structure is also known as a XLUnicodeString. -

    -

    -
    -
    - -
    - -

    -readUnicodeString

    -
    -public static java.lang.String readUnicodeString(LittleEndianInput in,
-                                                 int nChars)
    -
    -
    InputStream in is expected to contain: + This structure is also known as a XLUnicodeString.
    +
    • +
+ + + +
    +
  • +

    readUnicodeString

    +
    public static java.lang.String readUnicodeString(LittleEndianInput in,
+                                 int nChars)
    +
    InputStream in is expected to contain:
    1. byte is16BitFlag
    2. byte[]/char[] characterData
      3. @@ -572,41 +498,35 @@ public static java.lang.String readUn For this encoding, the is16BitFlag is always present even if nChars==0.
      This method should be used when the nChars field is not stored - as a ushort immediately before the is16BitFlag. Otherwise, readUnicodeString(LittleEndianInput) can be used. -

      -

      -
      -
      - -
      - -

      -writeUnicodeString

      -
      -public static void writeUnicodeString(LittleEndianOutput out,
-                                      java.lang.String value)
      -
      -
      OutputStream out will get: + as a ushort immediately before the is16BitFlag. Otherwise, readUnicodeString(LittleEndianInput) can be used.
    +
    • +
+ + + +
    +
  • +

    writeUnicodeString

    +
    public static void writeUnicodeString(LittleEndianOutput out,
+                      java.lang.String value)
    +
    OutputStream out will get:
    1. ushort nChars
    2. byte is16BitFlag
    3. byte[]/char[] characterData
    - For this encoding, the is16BitFlag is always present even if nChars==0. -

    -

    -
    -
    - -
    - -

    -writeUnicodeStringFlagAndData

    -
    -public static void writeUnicodeStringFlagAndData(LittleEndianOutput out,
-                                                 java.lang.String value)
    -
    -
    OutputStream out will get: + For this encoding, the is16BitFlag is always present even if nChars==0.
    +
    • +
+ + + +
    +
  • +

    writeUnicodeStringFlagAndData

    +
    public static void writeUnicodeStringFlagAndData(LittleEndianOutput out,
+                                 java.lang.String value)
    +
    OutputStream out will get:
    1. byte is16BitFlag
    2. byte[]/char[] characterData
      3. @@ -614,245 +534,224 @@ public static void writeUnicodeString For this encoding, the is16BitFlag is always present even if nChars==0.
      This method should be used when the nChars field is not stored - as a ushort immediately before the is16BitFlag. Otherwise, writeUnicodeString(LittleEndianOutput, String) can be used. -

      -

      -
      -
      - -
      - -

      -getEncodedSize

      -
      -public static int getEncodedSize(java.lang.String value)
      -
      -
      - -
      Returns:
      the number of bytes that would be written by writeUnicodeString(LittleEndianOutput, String)
      -
      -
      -
      - -

      -putCompressedUnicode

      -
      -public static void putCompressedUnicode(java.lang.String input,
-                                        byte[] output,
-                                        int offset)
      -
      -
      Takes a unicode (java) string, and returns it as 8 bit data (in ISO-8859-1 + as a ushort immediately before the is16BitFlag. Otherwise, writeUnicodeString(LittleEndianOutput, String) can be used.
    +
    • +
+ + + + + + + +
    +
  • +

    putCompressedUnicode

    +
    public static void putCompressedUnicode(java.lang.String input,
+                        byte[] output,
+                        int offset)
    +
    Takes a unicode (java) string, and returns it as 8 bit data (in ISO-8859-1 codepage). - (In Excel terms, write compressed 8 bit unicode) -

    -

    -
    Parameters:
    input - the String containing the data to be written
    output - the byte array to which the data is to be written
    offset - an offset into the byte arrat at which the data is start - when written
    -
    - -
    - -

    -putCompressedUnicode

    -
    -public static void putCompressedUnicode(java.lang.String input,
-                                        LittleEndianOutput out)
    -
    -
    -
    -
    -
    -
    - -

    -putUnicodeLE

    -
    -public static void putUnicodeLE(java.lang.String input,
-                                byte[] output,
-                                int offset)
    -
    -
    Takes a unicode string, and returns it as little endian (most + (In Excel terms, write compressed 8 bit unicode)
    +
    Parameters:
    input - the String containing the data to be written
    output - the byte array to which the data is to be written
    offset - an offset into the byte arrat at which the data is start + when written
    +
    • +
+ + + +
    +
  • +

    putCompressedUnicode

    +
    public static void putCompressedUnicode(java.lang.String input,
+                        LittleEndianOutput out)
    +
    • +
+ + + +
    +
  • +

    putUnicodeLE

    +
    public static void putUnicodeLE(java.lang.String input,
+                byte[] output,
+                int offset)
    +
    Takes a unicode string, and returns it as little endian (most important byte last) bytes in the supplied byte array. - (In Excel terms, write uncompressed unicode) -

    -

    -
    Parameters:
    input - the String containing the unicode data to be written
    output - the byte array to hold the uncompressed unicode, should be twice the length of the String
    offset - the offset to start writing into the byte array
    -
    - -
    - -

    -putUnicodeLE

    -
    -public static void putUnicodeLE(java.lang.String input,
-                                LittleEndianOutput out)
    -
    -
    -
    -
    -
    -
    - -

    -readUnicodeLE

    -
    -public static java.lang.String readUnicodeLE(LittleEndianInput in,
-                                             int nChars)
    -
    -
    -
    -
    -
    -
    - -

    -format

    -
    -public static java.lang.String format(java.lang.String message,
-                                      java.lang.Object[] params)
    -
    -
    Apply printf() like formatting to a string. - Primarily used for logging. -

    -

    -
    Parameters:
    message - the string with embedded formatting info - eg. "This is a test %2.2"
    params - array of values to format into the string -
    Returns:
    The formatted string
    -
    -
    -
    - -

    -getPreferredEncoding

    -
    -public static java.lang.String getPreferredEncoding()
    -
    -
    - -
    Returns:
    the encoding we want to use, currently hardcoded to ISO-8859-1
    -
    -
    -
    - -

    -hasMultibyte

    -
    -public static boolean hasMultibyte(java.lang.String value)
    -
    -
    check the parameter has multibyte character -

    -

    -
    Parameters:
    value - string to check -
    Returns:
    boolean result true:string has at least one multibyte character
    -
    -
    -
    - -

    -isUnicodeString

    -
    -public static boolean isUnicodeString(java.lang.String value)
    -
    -
    Checks to see if a given String needs to be represented as Unicode -

    -

    -
    Parameters:
    value - -
    Returns:
    true if string needs Unicode to be represented.
    -
    -
    -
    - -

    -mapMsCodepointString

    -
    -public static java.lang.String mapMsCodepointString(java.lang.String string)
    -
    -
    Some strings may contain encoded characters of the unicode private use area. + (In Excel terms, write uncompressed unicode)
    +
    Parameters:
    input - the String containing the unicode data to be written
    output - the byte array to hold the uncompressed unicode, should be twice the length of the String
    offset - the offset to start writing into the byte array
    +
    • +
+ + + +
    +
  • +

    putUnicodeLE

    +
    public static void putUnicodeLE(java.lang.String input,
+                LittleEndianOutput out)
    +
    • +
+ + + +
    +
  • +

    readUnicodeLE

    +
    public static java.lang.String readUnicodeLE(LittleEndianInput in,
+                             int nChars)
    +
    • +
+ + + +
    +
  • +

    format

    +
    public static java.lang.String format(java.lang.String message,
+                      java.lang.Object[] params)
    +
    Apply printf() like formatting to a string. + Primarily used for logging.
    +
    Parameters:
    message - the string with embedded formatting info + eg. "This is a test %2.2"
    params - array of values to format into the string
    +
    Returns:
    The formatted string
    +
    • +
+ + + +
    +
  • +

    getPreferredEncoding

    +
    public static java.lang.String getPreferredEncoding()
    +
    Returns:
    the encoding we want to use, currently hardcoded to ISO-8859-1
    +
    • +
+ + + +
    +
  • +

    hasMultibyte

    +
    public static boolean hasMultibyte(java.lang.String value)
    +
    check the parameter has multibyte character
    +
    Parameters:
    value - string to check
    +
    Returns:
    boolean result true:string has at least one multibyte character
    +
    • +
+ + + +
    +
  • +

    isUnicodeString

    +
    public static boolean isUnicodeString(java.lang.String value)
    +
    Checks to see if a given String needs to be represented as Unicode
    +
    Parameters:
    value -
    +
    Returns:
    true if string needs Unicode to be represented.
    +
    • +
+ + + + + + + +
    +
  • +

    mapMsCodepoint

    +
    public static void mapMsCodepoint(int msCodepoint,
+                  int unicodeCodepoint)
    +
    • +
+ + + + +
+
-
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- + + +
+ + +
+ + + - -
- - Copyright 2015 The Apache Software Foundation or +

+ Copyright 2016 The Apache Software Foundation or its licensors, as applicable. - - - +

+ + Modified: poi/site/publish/apidocs/org/apache/poi/util/SuppressForbidden.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/util/SuppressForbidden.html?rev=1723598&r1=1723597&r2=1723598&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/util/SuppressForbidden.html (original) +++ poi/site/publish/apidocs/org/apache/poi/util/SuppressForbidden.html Thu Jan 7 17:21:59 2016 @@ -1,208 +1,210 @@ - - - - -SuppressForbidden (POI API Documentation) - - - - - - - - - - - -
- - +//--> + + - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: REQUIRED | OPTIONAL -DETAIL: ELEMENT
- + + +
+ + +
+ + + - -
-

- -org.apache.poi.util -
-Annotation Type SuppressForbidden

-
-
-
@Retention(value=CLASS)
+

+
org.apache.poi.util

+
Annotation Type SuppressForbidden

+

+

+

+
    
+
  • 
+
    
+
    
+
    @Retention(value=CLASS)
 @Target(value={METHOD,TYPE})
-public @interface SuppressForbidden
- - -

-Marking class for elements to be ignored by the forbidden apis check -

- -

-

- -

+public @interface SuppressForbidden +

Marking class for elements to be ignored by the forbidden apis check
+ + + +
+
    +
  • - - - - - - - - - - -
    -Optional Element Summary
    - java.lang.Stringvalue - -
    -          A reason for suppressing should always be given.
    -  -

    -

    -value

    -
    -public abstract java.lang.String value
    -
    -
    A reason for suppressing should always be given. -

    -

    -
    -
    -
    -
    -
    -
    Default:
    ""
    -
    -
    +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.Stringvalue +
      A reason for suppressing should always be given.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        A reason for suppressing should always be given.
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+ -
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: REQUIRED | OPTIONAL -DETAIL: ELEMENT
- + + +
+ + +
+ + + - -
- - Copyright 2015 The Apache Software Foundation or +

+ Copyright 2016 The Apache Software Foundation or its licensors, as applicable. - - - +

+ + --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org For additional commands, e-mail: commits-help@poi.apache.org