Package org.apache.poi.ss.formula

Class SheetNameFormatter

  • public final class SheetNameFormatter
extends java.lang.Object
    Formats sheet names for use in formula expressions.

    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static void appendFormat​(java.lang.StringBuffer out, java.lang.String rawSheetName)
      Deprecated.
      use appendFormat(StringBuilder out, String rawSheetName) instead
      static void appendFormat​(java.lang.StringBuffer out, java.lang.String workbookName, java.lang.String rawSheetName)
      Deprecated.
      use appendFormat(StringBuilder out, String workbookName, String rawSheetName) instead
      static void appendFormat​(java.lang.StringBuilder out, java.lang.String rawSheetName)
      Convenience method for (format(String)) when a StringBuilder is already available.
      static void appendFormat​(java.lang.StringBuilder out, java.lang.String workbookName, java.lang.String rawSheetName)  
      static java.lang.String format​(java.lang.String rawSheetName)
      Used to format sheet names as they would appear in cell formula expressions.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • format

        public static java.lang.String format​(java.lang.String rawSheetName)
        Used to format sheet names as they would appear in cell formula expressions.
        Returns:
        the sheet name unchanged if there is no need for delimiting. Otherwise the sheet name is enclosed in single quotes ('). Any single quotes which were already present in the sheet name will be converted to double single quotes ('').

      • appendFormat

        @Deprecated
public static void appendFormat​(java.lang.StringBuffer out,
                                java.lang.String rawSheetName)
        Deprecated.
        use appendFormat(StringBuilder out, String rawSheetName) instead
        Convenience method for (format(String)) when a StringBuffer is already available.
        Parameters:
        out - - sheet name will be appended here possibly with delimiting quotes
        rawSheetName - - sheet name

      • appendFormat

        @Deprecated
public static void appendFormat​(java.lang.StringBuffer out,
                                java.lang.String workbookName,
                                java.lang.String rawSheetName)
        Deprecated.
        use appendFormat(StringBuilder out, String workbookName, String rawSheetName) instead

      • appendFormat

        public static void appendFormat​(java.lang.StringBuilder out,
                                java.lang.String rawSheetName)
        Convenience method for (format(String)) when a StringBuilder is already available.
        Parameters:
        out - - sheet name will be appended here possibly with delimiting quotes
        rawSheetName - - sheet name

      • appendFormat

        public static void appendFormat​(java.lang.StringBuilder out,
                                java.lang.String workbookName,
                                java.lang.String rawSheetName)