AbstractConverter (Cobble Lang 4.5.0 API)

java.lang.Object
- net.hasor.cobble.convert.convert.AbstractConverter

所有已实现的接口:

Converter

直接已知子类:

ArrayConverter, BooleanConverter, CharacterConverter, ClassConverter, DateTimeConverter, EnumConverter, FileConverter, NumberConverter, StringConverter, URIConverter, URLConverter
```
public abstract class AbstractConverter
extends Object
implements Converter
```
Base Converter implementation that provides the structure for handling conversion to and from a specified type.
This implementation provides the basic structure for converting to/from a specified type optionally using a default value or throwing a ConversionException if a conversion error occurs.
Implementations should provide conversion to the specified type and from the specified type to a String value by implementing the following methods:
- convertToString(value) - convert to a String (default implementation uses the objects toString() method).
- convertToType(Class, value) - convert to the specified type
从以下版本开始:

1.8.0

版本:

$Revision: 640131 $ $Date: 2008-03-23 02:10:31 +0000 (Sun, 23 Mar 2008) $

构造器概要

构造器
构造器和说明
`AbstractConverter()` 创建创造Converter转换器，可能会引发`ConversionException`异常。
`AbstractConverter(Object defaultValue)` 创建创造Converter转换器，可能会引发`ConversionException`异常。

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`Object`	`convert(Class<?> type, Object value)` Convert the input object into an output object of the specified type.
`protected Object`	`convertArray(Object value)` Return the first element from an Array (or Collection) or the value unchanged if not an Array (or Collection).
`protected String`	`convertToString(Object value)` 转换对象成为String格式。
`protected abstract Object`	`convertToType(Class<?> type, Object value)` 执行类型转换代码。
`protected Object`	`getDefault(Class<?> type)` 返回指定类型的默认值.
`protected abstract Class<?>`	`getDefaultType()` 获取默认值
`protected Object`	`handleError(Class<?> type, Object value, Throwable cause)` 处理转换错误。
`protected Object`	`handleMissing(Class<?> type)` 当遇到空值传入或者返回值为空的时候
`boolean`	`isUseDefault()` 当转换期间发生异常时是否使用默认值。
`protected void`	`setDefaultValue(Object defaultValue)` 设置默认值
`String`	`toString()` Provide a String representation of this converter.
`String`	`toString(Class<?> type)` Provide a String representation of a `java.lang.Class`.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - AbstractConverter
```
public AbstractConverter()
```
    创建创造Converter转换器，可能会引发ConversionException异常。
  - AbstractConverter
```
public AbstractConverter(Object defaultValue)
```
    创建创造Converter转换器，可能会引发ConversionException异常。
- 方法详细资料
  - isUseDefault
```
public boolean isUseDefault()
```
    当转换期间发生异常时是否使用默认值。
    
    返回:
    
    如果true则表示当遇到错误时设置的默认值会被返回。如果false会引发ConversionException异常。
  - convert
```
public Object convert(Class<?> type,
                      Object value)
```
    Convert the input object into an output object of the specified type.
    
    指定者:
    
    convert 在接口中 Converter
    
    参数:
    
    type - Data type to which this value should be converted
    
    value - The input value to be converted
    
    返回:
    
    The converted value.
    
    抛出:
    
    ConversionException - if conversion cannot be performed successfully and no default is specified.
  - handleError
```
protected Object handleError(Class<?> type,
                             Object value,
                             Throwable cause)
```
    处理转换错误。
    如果设置了default属性则当遇到错误时返回默认值。否则引发ConversionException异常。
  - convertToString
```
protected String convertToString(Object value)
                          throws Throwable
```
    转换对象成为String格式。
    注意：这个方法简单使用toString()实现该功能，子类应当重写该方法以完成特殊的转换过程。
    
    抛出:
    
    Throwable
  - convertToType
```
protected abstract Object convertToType(Class<?> type,
                                        Object value)
                                 throws Throwable
```
    执行类型转换代码。
    
    抛出:
    
    Throwable
  - convertArray
```
protected Object convertArray(Object value)
```
    Return the first element from an Array (or Collection) or the value unchanged if not an Array (or Collection). N.B. This needs to be overriden for array/Collection converters.
    
    参数:
    
    value - The value to convert
    
    返回:
    
    The first element in an Array (or Collection) or the value unchanged if not an Array (or Collection)
  - setDefaultValue
```
protected void setDefaultValue(Object defaultValue)
```
    设置默认值
  - getDefaultType
```
protected abstract Class<?> getDefaultType()
```
    获取默认值
  - getDefault
```
protected Object getDefault(Class<?> type)
```
    返回指定类型的默认值.
  - toString
```
public String toString()
```
    Provide a String representation of this converter.
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    A String representation of this converter
  - handleMissing
```
protected Object handleMissing(Class<?> type)
```
    当遇到空值传入或者返回值为空的时候
  - toString
```
public String toString(Class<?> type)
```
    Provide a String representation of a java.lang.Class.
    
    参数:
    
    type - The java.lang.Class.
    
    返回:
    
    The String representation.

类 AbstractConverter

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

AbstractConverter

AbstractConverter

方法详细资料

isUseDefault

convert

handleError

convertToString

convertToType

convertArray

setDefaultValue

getDefaultType

getDefault

toString

handleMissing

toString