org.apache.poi.ss.util
Class WorkbookUtil

java.lang.Object
  extended by org.apache.poi.ss.util.WorkbookUtil

public class WorkbookUtil
extends java.lang.Object

Helper methods for when working with Usermodel Workbooks


Constructor Summary
WorkbookUtil()
           
 
Method Summary
static java.lang.String createSafeSheetName(java.lang.String nameProposal)
          Creates a valid sheet name, which is conform to the rules.
static java.lang.String createSafeSheetName(java.lang.String nameProposal, char replaceChar)
          Creates a valid sheet name, which is conform to the rules.
static void validateSheetName(java.lang.String sheetName)
          Validates sheet name.
static void validateSheetState(int state)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WorkbookUtil

public WorkbookUtil()
Method Detail

createSafeSheetName

public static final java.lang.String createSafeSheetName(java.lang.String nameProposal)
Creates a valid sheet name, which is conform to the rules. In any case, the result safely can be used for Workbook.setSheetName(int, String).
Rules: Invalid characters are replaced by one space character ' '.

Parameters:
nameProposal - can be any string, will be truncated if necessary, allowed to be null
Returns:
a valid string, "empty" if to short, "null" if null

createSafeSheetName

public static final java.lang.String createSafeSheetName(java.lang.String nameProposal,
                                                         char replaceChar)
Creates a valid sheet name, which is conform to the rules. In any case, the result safely can be used for Workbook.setSheetName(int, String).
Rules:

Parameters:
nameProposal - can be any string, will be truncated if necessary, allowed to be null
replaceChar - the char to replace invalid characters.
Returns:
a valid string, "empty" if to short, "null" if null

validateSheetName

public static void validateSheetName(java.lang.String sheetName)
Validates sheet name.

The character count MUST be greater than or equal to 1 and less than or equal to 31. The string MUST NOT contain the any of the following characters:

The string MUST NOT begin or end with the single quote (') character.

Parameters:
sheetName - the name to validate

validateSheetState

public static void validateSheetState(int state)


Copyright 2012 The Apache Software Foundation or its licensors, as applicable.