public class DateTimeFormatterFactory extends java.lang.Object implements FactoryBean<DateTimeFormatter>
FactoryBean
that creates a Joda DateTimeFormatter
. Formatters will be
created using the defined pattern
, ISO
or style
(considered in that order).getDateTimeFormatter()
,
getDateTimeFormatter(DateTimeFormatter)
Modifier and Type | Field and Description |
---|---|
private DateTimeFormat.ISO |
iso |
private java.lang.String |
pattern |
private java.lang.String |
style |
private java.util.TimeZone |
timeZone |
Constructor and Description |
---|
DateTimeFormatterFactory()
Create a new
DateTimeFormatterFactory instance. |
DateTimeFormatterFactory(java.lang.String pattern)
Create a new
DateTimeFormatterFactory instance. |
Modifier and Type | Method and Description |
---|---|
private DateTimeFormatter |
createDateTimeFormatter() |
DateTimeFormatter |
getDateTimeFormatter()
Get a new DateTimeFormatter using this factory.
|
DateTimeFormatter |
getDateTimeFormatter(DateTimeFormatter fallbackFormatter)
Get a new DateTimeFormatter using this factory.
|
DateTimeFormatter |
getObject()
Return an instance (possibly shared or independent) of the object
managed by this factory.
|
java.lang.Class<?> |
getObjectType()
Return the type of object that this FactoryBean creates,
or
null if not known in advance. |
boolean |
isSingleton()
Is the object managed by this factory a singleton? That is,
will
FactoryBean.getObject() always return the same object
(a reference that can be cached)? |
void |
setIso(DateTimeFormat.ISO iso)
Set the ISO format used for this date.
|
void |
setPattern(java.lang.String pattern)
Set the pattern to use to format date values.
|
void |
setStyle(java.lang.String style)
Set the two character to use to format date values.
|
void |
setTimeZone(java.util.TimeZone timeZone)
Set the TimeZone to normalize the date values into, if any.
|
private DateTimeFormat.ISO iso
private java.lang.String style
private java.lang.String pattern
private java.util.TimeZone timeZone
public DateTimeFormatterFactory()
DateTimeFormatterFactory
instance.public DateTimeFormatterFactory(java.lang.String pattern)
DateTimeFormatterFactory
instance.pattern
- the pattern to use to format date valuespublic boolean isSingleton()
FactoryBean
FactoryBean.getObject()
always return the same object
(a reference that can be cached)?
NOTE: If a FactoryBean indicates to hold a singleton object,
the object returned from getObject()
might get cached
by the owning BeanFactory. Hence, do not return true
unless the FactoryBean always exposes the same reference.
The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.
NOTE: This method returning false
does not
necessarily indicate that returned objects are independent instances.
An implementation of the extended SmartFactoryBean
interface
may explicitly indicate independent instances through its
SmartFactoryBean.isPrototype()
method. Plain FactoryBean
implementations which do not implement this extended interface are
simply assumed to always return independent instances if the
isSingleton()
implementation returns false
.
isSingleton
in interface FactoryBean<DateTimeFormatter>
FactoryBean.getObject()
,
SmartFactoryBean.isPrototype()
public java.lang.Class<?> getObjectType()
FactoryBean
null
if not known in advance.
This allows one to check for specific types of beans without instantiating objects, for example on autowiring.
In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.
This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.
NOTE: Autowiring will simply ignore FactoryBeans that return
null
here. Therefore it is highly recommended to implement
this method properly, using the current state of the FactoryBean.
getObjectType
in interface FactoryBean<DateTimeFormatter>
null
if not known at the time of the callListableBeanFactory.getBeansOfType(java.lang.Class<T>)
public DateTimeFormatter getObject() throws java.lang.Exception
FactoryBean
As with a BeanFactory
, this allows support for both the
Singleton and Prototype design pattern.
If this FactoryBean is not fully initialized yet at the time of
the call (for example because it is involved in a circular reference),
throw a corresponding FactoryBeanNotInitializedException
.
As of Spring 2.0, FactoryBeans are allowed to return null
objects. The factory will consider this as normal value to be used; it
will not throw a FactoryBeanNotInitializedException in this case anymore.
FactoryBean implementations are encouraged to throw
FactoryBeanNotInitializedException themselves now, as appropriate.
getObject
in interface FactoryBean<DateTimeFormatter>
null
)java.lang.Exception
- in case of creation errorsFactoryBeanNotInitializedException
public DateTimeFormatter getDateTimeFormatter()
style
ISO
or
pattern
have been defined the
medium date time format
will be used.getObject()
,
getDateTimeFormatter(DateTimeFormatter)
public DateTimeFormatter getDateTimeFormatter(DateTimeFormatter fallbackFormatter)
style
ISO
or
pattern
have been defined the specific
fallbackFormatter
will be used.fallbackFormatter
- the fall-back formatter to use when no specific factory
properties have been set (can be null
).private DateTimeFormatter createDateTimeFormatter()
public void setTimeZone(java.util.TimeZone timeZone)
timeZone
- the time zonepublic void setStyle(java.lang.String style)
style
- two characters from the set {"S", "M", "L", "F", "-"}public void setIso(DateTimeFormat.ISO iso)
iso
- the iso formatpublic void setPattern(java.lang.String pattern)
pattern
- the format pattern