Package dev.orne.beans.converters

Class YearConverter

java.lang.Object

org.apache.commons.beanutils.converters.AbstractConverter

dev.orne.beans.converters.AbstractDateTimeConverter

dev.orne.beans.converters.YearConverter

All Implemented Interfaces:

org.apache.commons.beanutils.Converter

@API(status=STABLE,
     since="0.1")
public class YearConverter
extends AbstractDateTimeConverter

Implementation of Converter that converts Year instances to and from String using the year number as String representation.

Since:

0.1

Version:

1.0, 2020-05

Author:

(w) Iker Hernaez

Field Summary

Fields

Modifier and Type	Field	Description
static final DateTimeFormatter	BY_VALUE_PARSER	The year by value parser.

Constructor Summary

Constructors

Constructor	Description
YearConverter()	Creates a new instance that throws a ConversionException if an error occurs.
YearConverter(@NotNull DateTimeFormatter formatter)	Creates a new instance that throws a ConversionException if an error occurs.
YearConverter(@NotNull DateTimeFormatter formatter, Year defaultValue)	Creates a new instance that returns a default value if an error occurs.
YearConverter(Year defaultValue)	Creates a new instance that returns a default value if an error occurs.

Method Summary

Modifier and Type	Method	Description
protected <T> T	convertToType(@NotNull Class<T> type, Object value)
protected <T extends TemporalAccessor> T	fromTemporalAccessor(@NotNull Class<T> type, @NotNull TemporalAccessor value)	Converts the TemporalAccessor passed as argument to the specified type.
protected @NotNull Class<?>	getDefaultType()

Methods inherited from class dev.orne.beans.converters.AbstractDateTimeConverter

addParsers, addParsers, convertToString, getFormatter, getLogger, getParsers, parse, parseString, setParsers, setParsers

Methods inherited from class org.apache.commons.beanutils.converters.AbstractConverter

conversionException, convert, convertArray, getDefault, handleError, handleMissing, isUseDefault, setDefaultValue, toString

Methods inherited from class java.lang.Object

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

Field Details

BY_VALUE_PARSER

public static final DateTimeFormatter BY_VALUE_PARSER

The year by value parser.

Constructor Details

YearConverter

public YearConverter()

Creates a new instance that throws a ConversionException if an error occurs.

YearConverter

public YearConverter(Year defaultValue)

Creates a new instance that returns a default value if an error occurs.

Parameters:

defaultValue - The default value to be returned if the value to be converted is missing or an error occurs converting the value

YearConverter

public YearConverter(@NotNull
 @NotNull DateTimeFormatter formatter)

Creates a new instance that throws a ConversionException if an error occurs.

Parameters:

formatter - The temporal value formatter and default parser

YearConverter

public YearConverter(@NotNull
 @NotNull DateTimeFormatter formatter,
 Year defaultValue)

Creates a new instance that returns a default value if an error occurs.

Parameters:

formatter - The temporal value formatter and default parser

defaultValue - The default value to be returned if the value to be converted is missing or an error occurs converting the value

Method Details

getDefaultType

@NotNull
protected @NotNull Class<?> getDefaultType()

Specified by:

getDefaultType in class AbstractDateTimeConverter

convertToType

protected <T> T convertToType(@NotNull
 @NotNull Class<T> type,
 Object value)

Overrides:

convertToType in class AbstractDateTimeConverter

fromTemporalAccessor

protected <T extends TemporalAccessor> T fromTemporalAccessor(@NotNull
 @NotNull Class<T> type,
 @NotNull
 @NotNull TemporalAccessor value)

Converts the TemporalAccessor passed as argument to the specified type.

Specified by:

fromTemporalAccessor in class AbstractDateTimeConverter

Type Parameters:

T - The expected type of TemporalAccessor

Parameters:

type - The expected type of TemporalAccessor

value - The TemporalAccessor to convert to the expected type

Returns:

The converted TemporalAccessor of the expected type