Package net.sf.basedb.util.formatter

Class BooleanFormatter

java.lang.Object

net.sf.basedb.util.formatter.BooleanFormatter

All Implemented Interfaces:

ExcelFormatter<Boolean,Object>, Formatter<Boolean>

public class BooleanFormatter
extends Object
implements Formatter<Boolean>, ExcelFormatter<Boolean,Object>

Formats a boolean value. It is possible to select between yes/no, true/false, and 1/0 mappings.

Version:

2.0

Author:

nicklas

Last modified

$Date: 2024-10-30 13:32:46 +0100 (Wed, 30 Oct 2024) $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BooleanFormatter.Type	Enum for holding the various types of boolean output.

Field Summary

Fields

Modifier and Type	Field	Description
private final BooleanFormatter.Type	type

Constructor Summary

Constructors

Constructor	Description
BooleanFormatter(BooleanFormatter.Type type)	Create a new boolean formatter.

Method Summary

Modifier and Type	Method	Description
String	format(Boolean value)	Format a value by converting it to a string.
static BooleanFormatter	fromType(String type)	Create a formatter for boolean values.
Boolean	parseString(String value)	Parse a string and return a value of the correct type.
ExcelValue<Object>	toExcelValue(Boolean value)	Convert and format the given value to an Excel value.

Methods inherited from class java.lang.Object

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

Field Details

type

private final BooleanFormatter.Type type

Constructor Details

BooleanFormatter

public BooleanFormatter(BooleanFormatter.Type type)

Create a new boolean formatter.

Parameters:

type - The type of output

Method Details

fromType

public static BooleanFormatter fromType(String type)

Create a formatter for boolean values.

Returns:

A formatter or null if there is no type

Since:

3.19.12

format

public String format(Boolean value)

Description copied from interface: Formatter

Format a value by converting it to a string.

Specified by:

format in interface Formatter<Boolean>

Parameters:

value - The value to format

Returns:

A formatted string

parseString

public Boolean parseString(String value)

Description copied from interface: Formatter

Parse a string and return a value of the correct type. A null input string should (unless otherwise documented by a specific formatter implementation) be allowed and may return null or any other "default" value.

Specified by:

parseString in interface Formatter<Boolean>

Parameters:

value - The string to parse

Returns:

An object

toExcelValue

public ExcelValue<Object> toExcelValue(Boolean value)

Description copied from interface: ExcelFormatter

Convert and format the given value to an Excel value. If the value is null the implementation may return null to create an empty cell or it may return another non-null value.

Specified by:

toExcelValue in interface ExcelFormatter<Boolean,Object>

Since:

3.15