Class XSSFBSharedStringsTable

java.lang.Object
org.apache.poi.xssf.binary.XSSFBSharedStringsTable
All Implemented Interfaces:
SharedStrings

@Internal public class XSSFBSharedStringsTable extends Object implements SharedStrings
Since:
3.16-beta3
  • Constructor Details

  • Method Details

    • getItems

      @Removal(version="4.2") @Deprecated public List<String> getItems()
      Deprecated.
      use getItemAt instead
      Return all the strings. Formatting is ignored.
      Returns:
      a list with all the shared strings.
    • getEntryAt

      @Removal(version="4.2") @Deprecated public String getEntryAt(int idx)
      Deprecated.
      use getItemAt instead
      Return the string at a given index. Formatting is ignored.
      Parameters:
      idx - index of item to return.
      Returns:
      the item at the specified position in this Shared String table.
    • getItemAt

      public RichTextString getItemAt(int idx)
      Description copied from interface: SharedStrings
      Return a string item by index
      Specified by:
      getItemAt in interface SharedStrings
      Parameters:
      idx - index of item to return.
      Returns:
      the item at the specified position in this Shared String table.
    • getCount

      public int getCount()
      Return an integer representing the total count of strings in the workbook. This count does not include any numbers, it counts only the total of text strings in the workbook.
      Specified by:
      getCount in interface SharedStrings
      Returns:
      the total count of strings in the workbook
    • getUniqueCount

      public int getUniqueCount()
      Returns an integer representing the total count of unique strings in the Shared String Table. A string is unique even if it is a copy of another string, but has different formatting applied at the character level.
      Specified by:
      getUniqueCount in interface SharedStrings
      Returns:
      the total count of unique strings in the workbook