WorkbookCache (excel-builder 0.4.1 API)

com.jameskleeh.excel.WorkbookCache

A class used to store fonts and styles for reuse in workbooks
Authors:
James Kleeh
Since:
0.1.0

Properties Summary

Properties
Type	Name and description
`java.util.Map<java.lang.Object, org.apache.poi.xssf.usermodel.XSSFFont>`	`fonts`
`java.util.Map<java.lang.Object, org.apache.poi.xssf.usermodel.XSSFCellStyle>`	`styles`

Constructor Summary

Constructors
Constructor and description
`WorkbookCache (org.apache.poi.xssf.usermodel.XSSFWorkbook workbook)`

Methods Summary

Methods
Type	Name and description
`java.lang.Boolean`	`containsFont(java.lang.Object obj)` Determines if a font has been built for a given set of options
`java.lang.Boolean`	`containsStyle(java.lang.Object obj)` Determines if a style has been built for a given set of options
`org.apache.poi.xssf.usermodel.XSSFFont`	`getFont(java.lang.Object obj)` @param obj Font options
`org.apache.poi.xssf.usermodel.XSSFCellStyle`	`getStyle(java.lang.Object obj)` @param obj Style options
`void`	`putFont(java.lang.Object obj, org.apache.poi.xssf.usermodel.XSSFFont font)` Adds a font to the cache
`void`	`putStyle(java.lang.Object obj, org.apache.poi.xssf.usermodel.XSSFCellStyle style)` Adds a style to the cache

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - final java.util.Map<java.lang.Object, org.apache.poi.xssf.usermodel.XSSFFont> fonts
  - final java.util.Map<java.lang.Object, org.apache.poi.xssf.usermodel.XSSFCellStyle> styles
- Constructor Detail
  - WorkbookCache(org.apache.poi.xssf.usermodel.XSSFWorkbook workbook)
- Method Detail
  - java.lang.Boolean containsFont(java.lang.Object obj)
    
    Determines if a font has been built for a given set of options
    Parameters:
    obj - Font options
    Returns:
    Whether the font exists in the cache
  - java.lang.Boolean containsStyle(java.lang.Object obj)
    
    Determines if a style has been built for a given set of options
    Parameters:
    obj - Style options
    Returns:
    Whether the style exists in the cache
  - org.apache.poi.xssf.usermodel.XSSFFont getFont(java.lang.Object obj)
    
    Parameters:
    obj - Font options
    Returns:
    The built font object
  - org.apache.poi.xssf.usermodel.XSSFCellStyle getStyle(java.lang.Object obj)
    
    Parameters:
    obj - Style options
    Returns:
    The built style object
  - void putFont(java.lang.Object obj, org.apache.poi.xssf.usermodel.XSSFFont font)
    
    Adds a font to the cache
    Parameters:
    obj - Font options
    font - Font object
  - void putStyle(java.lang.Object obj, org.apache.poi.xssf.usermodel.XSSFCellStyle style)
    
    Adds a style to the cache
    Parameters:
    obj - Style options
    style - Style object

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class WorkbookCache

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

final java.util.Map<java.lang.Object, org.apache.poi.xssf.usermodel.XSSFFont> fonts

final java.util.Map<java.lang.Object, org.apache.poi.xssf.usermodel.XSSFCellStyle> styles

Constructor Detail

WorkbookCache(org.apache.poi.xssf.usermodel.XSSFWorkbook workbook)

Method Detail

java.lang.Boolean containsFont(java.lang.Object obj)

java.lang.Boolean containsStyle(java.lang.Object obj)

org.apache.poi.xssf.usermodel.XSSFFont getFont(java.lang.Object obj)

org.apache.poi.xssf.usermodel.XSSFCellStyle getStyle(java.lang.Object obj)

void putFont(java.lang.Object obj, org.apache.poi.xssf.usermodel.XSSFFont font)

void putStyle(java.lang.Object obj, org.apache.poi.xssf.usermodel.XSSFCellStyle style)