FastDateFormat (hutool 6.0.0-M20 API)

java.lang.Object
- java.text.Format
- - org.dromara.hutool.core.date.format.FastDateFormat

All Implemented Interfaces:

Serializable, Cloneable, DateBasic, DatePrinter, DateParser, PositionDateParser
```
public class FastDateFormat
extends Format
implements PositionDateParser, DatePrinter
```
FastDateFormat 是一个线程安全的 SimpleDateFormat 实现：
- 日期字符串解析
- 日期格式化
通过以下静态方法获得此对象:
getInstance(String, TimeZone, Locale)
getDateInstance(int, TimeZone, Locale)
getTimeInstance(int, TimeZone, Locale)
getDateTimeInstance(int, int, TimeZone, Locale)
Thanks to Apache Commons Lang 3.5
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.text.Format
  Format.Field

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FULL` FULL locale dependent date or time style.
`static int`	`LONG` LONG locale dependent date or time style.
`static int`	`MEDIUM` MEDIUM locale dependent date or time style.
`static int`	`SHORT` SHORT locale dependent date or time style.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`FastDateFormat(String pattern, TimeZone timeZone, Locale locale)` 构造
`protected`	`FastDateFormat(String pattern, TimeZone timeZone, Locale locale, Date centuryStart)` 构造

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`format(Calendar calendar)` Formats a `Calendar` object.
`<B extends Appendable> B`	`format(Calendar calendar, B buf)` Formats a `Calendar` object into the supplied `Appendable`.
`String`	`format(Date date)` 使用 `GregorianCalendar` 格式化 `Date`
`<B extends Appendable> B`	`format(Date date, B buf)` Formats a `Date` object into the supplied `Appendable` using a `GregorianCalendar`.
`String`	`format(long millis)` 格式化日期表示的毫秒数
`<B extends Appendable> B`	`format(long millis, B buf)` Formats a millisecond `long` value into the supplied `Appendable`.
`StringBuffer`	`format(Object obj, StringBuffer toAppendTo, FieldPosition pos)`
`static FastDateFormat`	`getDateInstance(int style)` 获得 FastDateFormat 实例支持缓存
`static FastDateFormat`	`getDateInstance(int style, Locale locale)` 获得 FastDateFormat 实例支持缓存
`static FastDateFormat`	`getDateInstance(int style, TimeZone timeZone)` 获得 FastDateFormat 实例支持缓存
`static FastDateFormat`	`getDateInstance(int style, TimeZone timeZone, Locale locale)` 获得 FastDateFormat 实例支持缓存
`DateTimeFormatter`	`getDateTimeFormatter()` 便捷获取 DateTimeFormatter 由于 `DateFormatPool` 很大一部分的格式没有提供 `DateTimeFormatter`,因此这里提供快捷获取方式
`static FastDateFormat`	`getDateTimeInstance(int dateStyle, int timeStyle)` 获得 FastDateFormat 实例支持缓存
`static FastDateFormat`	`getDateTimeInstance(int dateStyle, int timeStyle, Locale locale)` 获得 FastDateFormat 实例支持缓存
`static FastDateFormat`	`getDateTimeInstance(int dateStyle, int timeStyle, TimeZone timeZone)` 获得 FastDateFormat 实例支持缓存
`static FastDateFormat`	`getDateTimeInstance(int dateStyle, int timeStyle, TimeZone timeZone, Locale locale)` 获得 FastDateFormat 实例支持缓存
`static FastDateFormat`	`getInstance()` 获得 FastDateFormat实例，使用默认格式和地区
`static FastDateFormat`	`getInstance(String pattern)` 获得 FastDateFormat 实例，使用默认地区支持缓存
`static FastDateFormat`	`getInstance(String pattern, Locale locale)` 获得 FastDateFormat 实例支持缓存
`static FastDateFormat`	`getInstance(String pattern, TimeZone timeZone)` 获得 FastDateFormat 实例支持缓存
`static FastDateFormat`	`getInstance(String pattern, TimeZone timeZone, Locale locale)` 获得 FastDateFormat 实例支持缓存
`Locale`	`getLocale()` 获得日期地理位置
`int`	`getMaxLengthEstimate()` 估算生成的日期字符串长度实际生成的字符串长度小于或等于此值
`String`	`getPattern()` 获得日期格式化或者转换的格式
`static FastDateFormat`	`getTimeInstance(int style)` 获得 FastDateFormat 实例支持缓存
`static FastDateFormat`	`getTimeInstance(int style, Locale locale)` 获得 FastDateFormat 实例支持缓存
`static FastDateFormat`	`getTimeInstance(int style, TimeZone timeZone)` 获得 FastDateFormat 实例支持缓存
`static FastDateFormat`	`getTimeInstance(int style, TimeZone timeZone, Locale locale)` 获得 FastDateFormat 实例支持缓存
`TimeZone`	`getTimeZone()` 获得时区
`int`	`hashCode()`
`Date`	`parse(CharSequence source)` 将日期字符串解析并转换为 `Date` 对象
`boolean`	`parse(CharSequence source, ParsePosition pos, Calendar calendar)` 根据给定格式更新`Calendar` 解析成功后，`ParsePosition.getIndex()`更新成转换到的位置失败则`ParsePosition.getErrorIndex()`更新到解析失败的位置
`Object`	`parseObject(String source, ParsePosition pos)`
`String`	`toString()`

Methods inherited from class java.text.Format
clone, format, formatToCharacterIterator, parseObject

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dromara.hutool.core.date.format.parser.PositionDateParser
parse, parseCalendar

- Field Detail
  - FULL
```
public static final int FULL
```
    FULL locale dependent date or time style.
    
    See Also:
    
    Constant Field Values
  - LONG
```
public static final int LONG
```
    LONG locale dependent date or time style.
    
    See Also:
    
    Constant Field Values
  - MEDIUM
```
public static final int MEDIUM
```
    MEDIUM locale dependent date or time style.
    
    See Also:
    
    Constant Field Values
  - SHORT
```
public static final int SHORT
```
    SHORT locale dependent date or time style.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FastDateFormat
```
protected FastDateFormat(String pattern,
                         TimeZone timeZone,
                         Locale locale)
```
    构造
    
    Parameters:
    
    pattern - 使用SimpleDateFormat 相同的日期格式
    
    timeZone - 非空时区 TimeZone
    
    locale - Locale 日期地理位置
    
    Throws:
    
    NullPointerException - if pattern, timeZone, or locale is null.
  - FastDateFormat
```
protected FastDateFormat(String pattern,
                         TimeZone timeZone,
                         Locale locale,
                         Date centuryStart)
```
    构造
    
    Parameters:
    
    pattern - 使用SimpleDateFormat 相同的日期格式
    
    timeZone - 非空时区 TimeZone
    
    locale - Locale 日期地理位置
    
    centuryStart - The start of the 100 year period to use as the "default century" for 2 digit year parsing. If centuryStart is null, defaults to now - 80 years
    
    Throws:
    
    NullPointerException - if pattern, timeZone, or locale is null.
- Method Detail
  - getInstance
```
public static FastDateFormat getInstance()
```
    获得 FastDateFormat实例，使用默认格式和地区
    
    Returns:
    
    FastDateFormat
  - getInstance
```
public static FastDateFormat getInstance(String pattern)
```
    获得 FastDateFormat 实例，使用默认地区
    支持缓存
    
    Parameters:
    
    pattern - 使用SimpleDateFormat 相同的日期格式
    
    Returns:
    
    FastDateFormat
    
    Throws:
    
    IllegalArgumentException - 日期格式问题
  - getInstance
```
public static FastDateFormat getInstance(String pattern,
                                         TimeZone timeZone)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    pattern - 使用SimpleDateFormat 相同的日期格式
    
    timeZone - 时区TimeZone
    
    Returns:
    
    FastDateFormat
    
    Throws:
    
    IllegalArgumentException - 日期格式问题
  - getInstance
```
public static FastDateFormat getInstance(String pattern,
                                         Locale locale)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    pattern - 使用SimpleDateFormat 相同的日期格式
    
    locale - Locale 日期地理位置
    
    Returns:
    
    FastDateFormat
    
    Throws:
    
    IllegalArgumentException - 日期格式问题
  - getInstance
```
public static FastDateFormat getInstance(String pattern,
                                         TimeZone timeZone,
                                         Locale locale)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    pattern - 使用SimpleDateFormat 相同的日期格式
    
    timeZone - 时区TimeZone
    
    locale - Locale 日期地理位置
    
    Returns:
    
    FastDateFormat
    
    Throws:
    
    IllegalArgumentException - 日期格式问题
  - getDateInstance
```
public static FastDateFormat getDateInstance(int style)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    style - date style: FULL, LONG, MEDIUM, or SHORT
    
    Returns:
    
    本地化 FastDateFormat
  - getDateInstance
```
public static FastDateFormat getDateInstance(int style,
                                             Locale locale)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    style - date style: FULL, LONG, MEDIUM, or SHORT
    
    locale - Locale 日期地理位置
    
    Returns:
    
    本地化 FastDateFormat
  - getDateInstance
```
public static FastDateFormat getDateInstance(int style,
                                             TimeZone timeZone)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    style - date style: FULL, LONG, MEDIUM, or SHORT
    
    timeZone - 时区TimeZone
    
    Returns:
    
    本地化 FastDateFormat
  - getDateInstance
```
public static FastDateFormat getDateInstance(int style,
                                             TimeZone timeZone,
                                             Locale locale)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    style - date style: FULL, LONG, MEDIUM, or SHORT
    
    timeZone - 时区TimeZone
    
    locale - Locale 日期地理位置
    
    Returns:
    
    本地化 FastDateFormat
  - getTimeInstance
```
public static FastDateFormat getTimeInstance(int style)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    style - time style: FULL, LONG, MEDIUM, or SHORT
    
    Returns:
    
    本地化 FastDateFormat
  - getTimeInstance
```
public static FastDateFormat getTimeInstance(int style,
                                             Locale locale)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    style - time style: FULL, LONG, MEDIUM, or SHORT
    
    locale - Locale 日期地理位置
    
    Returns:
    
    本地化 FastDateFormat
  - getTimeInstance
```
public static FastDateFormat getTimeInstance(int style,
                                             TimeZone timeZone)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    style - time style: FULL, LONG, MEDIUM, or SHORT
    
    timeZone - optional time zone, overrides time zone of formatted time
    
    Returns:
    
    本地化 FastDateFormat
  - getTimeInstance
```
public static FastDateFormat getTimeInstance(int style,
                                             TimeZone timeZone,
                                             Locale locale)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    style - time style: FULL, LONG, MEDIUM, or SHORT
    
    timeZone - optional time zone, overrides time zone of formatted time
    
    locale - Locale 日期地理位置
    
    Returns:
    
    本地化 FastDateFormat
  - getDateTimeInstance
```
public static FastDateFormat getDateTimeInstance(int dateStyle,
                                                 int timeStyle)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    dateStyle - date style: FULL, LONG, MEDIUM, or SHORT
    
    timeStyle - time style: FULL, LONG, MEDIUM, or SHORT
    
    Returns:
    
    本地化 FastDateFormat
  - getDateTimeInstance
```
public static FastDateFormat getDateTimeInstance(int dateStyle,
                                                 int timeStyle,
                                                 Locale locale)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    dateStyle - date style: FULL, LONG, MEDIUM, or SHORT
    
    timeStyle - time style: FULL, LONG, MEDIUM, or SHORT
    
    locale - Locale 日期地理位置
    
    Returns:
    
    本地化 FastDateFormat
  - getDateTimeInstance
```
public static FastDateFormat getDateTimeInstance(int dateStyle,
                                                 int timeStyle,
                                                 TimeZone timeZone)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    dateStyle - date style: FULL, LONG, MEDIUM, or SHORT
    
    timeStyle - time style: FULL, LONG, MEDIUM, or SHORT
    
    timeZone - 时区TimeZone
    
    Returns:
    
    本地化 FastDateFormat
  - getDateTimeInstance
```
public static FastDateFormat getDateTimeInstance(int dateStyle,
                                                 int timeStyle,
                                                 TimeZone timeZone,
                                                 Locale locale)
```
    获得 FastDateFormat 实例
    支持缓存
    
    Parameters:
    
    dateStyle - date style: FULL, LONG, MEDIUM, or SHORT
    
    timeStyle - time style: FULL, LONG, MEDIUM, or SHORT
    
    timeZone - 时区TimeZone
    
    locale - Locale 日期地理位置
    
    Returns:
    
    本地化 FastDateFormat
  - format
```
public StringBuffer format(Object obj,
                           StringBuffer toAppendTo,
                           FieldPosition pos)
```
    Specified by:
    
    format in class Format
  - format
```
public String format(long millis)
```
    Description copied from interface: DatePrinter
    
    格式化日期表示的毫秒数
    
    Specified by:
    
    format in interface DatePrinter
    
    Parameters:
    
    millis - 日期毫秒数
    
    Returns:
    
    the formatted string
  - format
```
public String format(Date date)
```
    Description copied from interface: DatePrinter
    
    使用 GregorianCalendar 格式化 Date
    
    Specified by:
    
    format in interface DatePrinter
    
    Parameters:
    
    date - 日期 Date
    
    Returns:
    
    格式化后的字符串
  - format
```
public String format(Calendar calendar)
```
    Description copied from interface: DatePrinter
    
    Formats a Calendar object.
    格式化 Calendar
    
    Specified by:
    
    format in interface DatePrinter
    
    Parameters:
    
    calendar - Calendar
    
    Returns:
    
    格式化后的字符串
  - format
```
public <B extends Appendable> B format(long millis,
                                       B buf)
```
    Description copied from interface: DatePrinter
    
    Formats a millisecond long value into the supplied Appendable.
    
    Specified by:
    
    format in interface DatePrinter
    
    Type Parameters:
    
    B - the Appendable class type, usually StringBuilder or StringBuffer.
    
    Parameters:
    
    millis - the millisecond value to format
    
    buf - the buffer to format into
    
    Returns:
    
    the specified string buffer
  - format
```
public <B extends Appendable> B format(Date date,
                                       B buf)
```
    Description copied from interface: DatePrinter
    
    Formats a Date object into the supplied Appendable using a GregorianCalendar.
    
    Specified by:
    
    format in interface DatePrinter
    
    Type Parameters:
    
    B - the Appendable class type, usually StringBuilder or StringBuffer.
    
    Parameters:
    
    date - the date to format
    
    buf - the buffer to format into
    
    Returns:
    
    the specified string buffer
  - format
```
public <B extends Appendable> B format(Calendar calendar,
                                       B buf)
```
    Description copied from interface: DatePrinter
    
    Formats a Calendar object into the supplied Appendable.
    The TimeZone set on the Calendar is only used to adjust the time offset. The TimeZone specified during the construction of the Parser will determine the TimeZone used in the formatted string.
    
    Specified by:
    
    format in interface DatePrinter
    
    Type Parameters:
    
    B - the Appendable class type, usually StringBuilder or StringBuffer.
    
    Parameters:
    
    calendar - the calendar to format
    
    buf - the buffer to format into
    
    Returns:
    
    the specified string buffer
  - parse
```
public Date parse(CharSequence source)
           throws DateException
```
    Description copied from interface: DateParser
    
    将日期字符串解析并转换为 Date 对象
    
    Specified by:
    
    parse in interface DateParser
    
    Parameters:
    
    source - 被解析的日期字符串
    
    Returns:
    
    Date对象
    
    Throws:
    
    DateException - 转换异常，被转换的字符串格式错误。
  - parse
```
public boolean parse(CharSequence source,
                     ParsePosition pos,
                     Calendar calendar)
```
    Description copied from interface: PositionDateParser
    
    根据给定格式更新Calendar
    解析成功后，ParsePosition.getIndex()更新成转换到的位置
    失败则ParsePosition.getErrorIndex()更新到解析失败的位置
    
    Specified by:
    
    parse in interface PositionDateParser
    
    Parameters:
    
    source - 被转换的日期字符串
    
    pos - 定义开始转换的位置，转换结束后更新转换到的位置，null表示忽略，从第一个字符开始转换
    
    calendar - 解析并更新的Calendar
    
    Returns:
    
    解析成功返回 true，否则返回false
  - parseObject
```
public Object parseObject(String source,
                          ParsePosition pos)
```
    Specified by:
    
    parseObject in class Format
  - getPattern
```
public String getPattern()
```
    Description copied from interface: DateBasic
    
    获得日期格式化或者转换的格式
    
    Specified by:
    
    getPattern in interface DateBasic
    
    Returns:
    
    SimpleDateFormat兼容的格式
  - getTimeZone
```
public TimeZone getTimeZone()
```
    Description copied from interface: DateBasic
    
    获得时区
    
    Specified by:
    
    getTimeZone in interface DateBasic
    
    Returns:
    
    TimeZone
  - getLocale
```
public Locale getLocale()
```
    Description copied from interface: DateBasic
    
    获得日期地理位置
    
    Specified by:
    
    getLocale in interface DateBasic
    
    Returns:
    
    Locale
  - getMaxLengthEstimate
```
public int getMaxLengthEstimate()
```
    估算生成的日期字符串长度
    实际生成的字符串长度小于或等于此值
    
    Returns:
    
    日期字符串长度
  - getDateTimeFormatter
```
public DateTimeFormatter getDateTimeFormatter()
```
    便捷获取 DateTimeFormatter 由于 DateFormatPool 很大一部分的格式没有提供 DateTimeFormatter,因此这里提供快捷获取方式
    
    Returns:
    
    DateTimeFormatter
    
    Since:
    
    5.6.4
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class FastDateFormat

Nested Class Summary

Nested classes/interfaces inherited from class java.text.Format

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.text.Format

Methods inherited from class java.lang.Object

Methods inherited from interface org.dromara.hutool.core.date.format.parser.PositionDateParser

Field Detail

FULL

LONG

MEDIUM

SHORT

Constructor Detail

FastDateFormat

FastDateFormat

Method Detail

getInstance

getInstance

getInstance

getInstance

getInstance

getDateInstance

getDateInstance

getDateInstance

getDateInstance

getTimeInstance

getTimeInstance

getTimeInstance

getTimeInstance

getDateTimeInstance

getDateTimeInstance

getDateTimeInstance

getDateTimeInstance

format

format

format

format

format

format

format

parse

parse

parseObject

getPattern

getTimeZone

getLocale

getMaxLengthEstimate

getDateTimeFormatter

equals

hashCode

toString