org.subtlelib.poi.api.row

Interface PlainDataOutput

All Known Subinterfaces:

RowContext

All Known Implementing Classes:

AbstractDelegatingRowContext, RowContextImpl, RowContextNoImpl

public interface PlainDataOutput

Basic data output functionality

Author:

i.voshkulat

Method Summary

Modifier and Type	Method and Description
RowContext	date(Date date) Write mandatory date to the current cell.
RowContext	date(Date date, Style style) Write mandatory date to the current cell.
RowContext	date(com.google.common.base.Optional<Date> date)
RowContext	date(com.google.common.base.Optional<Date> date, Style style)
RowContext	multilineText(Collection<String> lines) Write mandatory multiline text to the current cell.
RowContext	multilineText(Collection<String> lines, Style style) Write mandatory multiline text to the current cell.
RowContext	number(Number number) Write mandatory number to the current cell.
RowContext	number(Number number, Style style) Write mandatory number to the current cell.
RowContext	number(com.google.common.base.Optional<? extends Number> number) Write optional number to the current cell.
RowContext	number(com.google.common.base.Optional<? extends Number> number, Style style) Write optional number to the current cell and apply style provided.
RowContext	text(com.google.common.base.Optional<String> text) Write optional text to the current cell.
RowContext	text(com.google.common.base.Optional<String> text, Style style) Write optional text to the current cell and apply style provided.
RowContext	text(String text) Write mandatory text to the current cell.
RowContext	text(String text, Style style) Write mandatory text to the current cell.

Method Detail

text

RowContext text(String text)

Write mandatory text to the current cell. Shift current cell pointer to the next position. Style as per StyleConfiguration.getTextStyle() on the current level is applied. For details of style configuration please see StyleConfiguration implementation used.

Parameters:

text - non-null string

Returns:

this

text

RowContext text(String text,
                Style style)

Write mandatory text to the current cell. Shift current cell pointer to the next position. Style which is a product of merging/overwriting StyleConfiguration.getTextStyle() with a provided style is applied. For details of style configuration please see StyleConfiguration implementation used. For details of style merging see actual Style in use.

Parameters:

text - non-null string

style - style to be applied to the current cell on top of the predefined style

Returns:

this

text

RowContext text(com.google.common.base.Optional<String> text)

Write optional text to the current cell. Same as text(String) but the value is optional.

Parameters:

text - for Present string - value is written, on Absent value the cell is skipped

Returns:

this

text

RowContext text(com.google.common.base.Optional<String> text,
                Style style)

Write optional text to the current cell and apply style provided. Same as text(String, Style) but the value is optional.

Parameters:

text - for Present string - value is written, on Absent value the cell is skipped

style - style to be applied to the current cell on top of the predefined style

Returns:

this

multilineText

RowContext multilineText(Collection<String> lines)

Write mandatory multiline text to the current cell. Shift current cell pointer to the next position. Style as per StyleConfiguration.getTextStyle() on the current level is applied. For details of style configuration please see StyleConfiguration implementation used.

Parameters:

lines - non-null collection of strings

Returns:

this

multilineText

RowContext multilineText(Collection<String> lines,
                         Style style)

Write mandatory multiline text to the current cell. Shift current cell pointer to the next position. Style which is a product of merging/overwriting StyleConfiguration.getTextStyle() with a provided style is applied. For details of style configuration please see StyleConfiguration implementation used. For details of style merging see actual Style in use.

Parameters:

lines - non-null collection of strings

style - style to be applied to the current cell on top of the predefined style

Returns:

this

number

RowContext number(Number number)

Write mandatory number to the current cell. Shift current cell pointer to the next position. Style as per StyleConfiguration.getNumberStyle() on the current level is applied. For details of style configuration please see StyleConfiguration implementation used.

Parameters:

number - non-null number

Returns:

this

number

RowContext number(Number number,
                  Style style)

Write mandatory number to the current cell. Shift current cell pointer to the next position. Style which is a product of merging/overwriting StyleConfiguration.getNumberStyle() with a provided style is applied. For details of style configuration please see StyleConfiguration implementation used. For details of style merging see actual Style in use.

Parameters:

number - non-null number

style - style to be applied to the current cell on top of the predefined style

Returns:

this

number

RowContext number(com.google.common.base.Optional<? extends Number> number)

Write optional number to the current cell. Same as number(Number) but the value is optional.

Parameters:

number - Present value is written, on Absent value the cell is skipped

Returns:

this

number

RowContext number(com.google.common.base.Optional<? extends Number> number,
                  Style style)

Write optional number to the current cell and apply style provided. Same as number(Number, Style) but the value is optional.

Parameters:

number - Present value is written, on Absent value the cell is skipped

style - style to be applied to the current cell on top of the predefined style

Returns:

this

date

RowContext date(Date date)

Write mandatory date to the current cell. Shift current cell pointer to the next position. Style as per StyleConfiguration.getDateStyle() on the current level is applied. For details of style configuration please see StyleConfiguration implementation used. For details of style merging see actual Style in use.

Parameters:

date - non-null date

Returns:

this

date

RowContext date(Date date,
                Style style)

Write mandatory date to the current cell. Shift current cell pointer to the next position. Style which is a product of merging/overwriting StyleConfiguration.getDateStyle() with a provided style is applied. For details of style configuration please see StyleConfiguration implementation used. For details of style merging see actual Style in use.

Parameters:

date - non-null date

style - style to be applied to the current cell on top of the predefined style

Returns:

this

date

RowContext date(com.google.common.base.Optional<Date> date)

date

RowContext date(com.google.common.base.Optional<Date> date,
                Style style)