|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.velocity.tools.ConversionUtils
public class ConversionUtils
Utility methods for parsing or otherwise converting between types. Current supported types are Number, Date, Calendar, String, Boolean, Locale and URL
Field Summary | |
---|---|
static ConversionUtils |
INSTANCE
|
Method Summary | |
---|---|
static DateFormat |
getDateFormat(int dateStyle,
int timeStyle,
Locale locale,
TimeZone timezone)
Returns a DateFormat instance for the specified
time style, date style, Locale , and TimeZone . |
static DateFormat |
getDateFormat(String format,
Locale locale,
TimeZone timezone)
Returns a DateFormat instance for the specified
format, Locale , and TimeZone . |
static DateFormat |
getDateFormat(String dateStyle,
String timeStyle,
Locale locale,
TimeZone timezone)
Returns a DateFormat instance for the specified
date style, time style, Locale , and TimeZone . |
static int |
getDateStyleAsInt(String style)
Checks a string to see if it matches one of the standard DateFormat style patterns: full, long, medium, short, or default. |
ConversionUtils |
getInstance()
|
static NumberFormat |
getNumberFormat(int numberStyle,
Locale locale)
Returns a NumberFormat instance for the specified
number style and Locale . |
static NumberFormat |
getNumberFormat(String format,
Locale locale)
Returns a NumberFormat instance for the specified
format and Locale . |
static int |
getNumberStyleAsInt(String style)
Checks a string to see if it matches one of the standard NumberFormat style patterns: number, currency, percent, integer, or default. |
static Boolean |
toBoolean(Object value)
Converts any Object to a boolean using toString(Object)
and Boolean.valueOf(String) . |
static Calendar |
toCalendar(Date date,
Locale locale)
|
static Date |
toDate(Object obj)
Attempts to convert an unidentified Object into a Date ,
just short of turning it into a string and parsing it. |
static Date |
toDate(Object obj,
String format,
Locale locale,
TimeZone timezone)
Converts an object to an instance of Date using the
specified format, Locale , and TimeZone if the
object is not already an instance of Date, Calendar, or Long. |
static Date |
toDate(String str,
String format,
Locale locale,
TimeZone timezone)
Converts an object to an instance of Date using the
specified format, Locale , and TimeZone if the
object is not already an instance of Date, Calendar, or Long. |
static Locale |
toLocale(String value)
Converts a string to a Locale |
static Number |
toNumber(Object obj)
Attempts to convert an unidentified Object into a Number ,
just short of turning it into a string and parsing it. |
static Number |
toNumber(Object obj,
boolean handleStrings)
Just like toNumber(Object) except that you can tell
this to attempt parsing the object as a String by passing true
as the second parameter. |
static Number |
toNumber(Object value,
String format,
Locale locale)
Converts an object to an instance of Number using the
specified format and Locale to parse it, if necessary. |
static Number |
toNumber(String value,
String format,
Locale locale)
Converts a string to an instance of Number using the
specified format and Locale to parse it. |
static String |
toString(Collection values)
Returns the first value as a String, if any; otherwise returns null. |
static String |
toString(Object value)
Converts objects to String in a more Tools-ish way than String.valueOf(Object), especially with nulls, Arrays and Collections. |
static URL |
toURL(String value)
Converts a string to a URL . |
static URL |
toURL(String value,
Object caller)
Converts a string to a URL . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final ConversionUtils INSTANCE
Method Detail |
---|
public ConversionUtils getInstance()
public static NumberFormat getNumberFormat(String format, Locale locale)
NumberFormat
instance for the specified
format and Locale
. If the format specified is a standard
style pattern, then a number instance
will be returned with the number style set to the
specified style. If it is a custom format, then a customized
NumberFormat
will be returned.
format
- the custom or standard formatting pattern to be usedlocale
- the Locale
to be used
NumberFormat
NumberFormat
public static NumberFormat getNumberFormat(int numberStyle, Locale locale)
NumberFormat
instance for the specified
number style and Locale
.
numberStyle
- the number style (number will be ignored if this is
less than zero or the number style is not recognized)locale
- the Locale
to be used
NumberFormat
or null
if an instance cannot be constructed with the given
parameterspublic static int getNumberStyleAsInt(String style)
style
- the string to be checked
NumberFormat
public static Number toNumber(Object obj)
Object
into a Number
,
just short of turning it into a string and parsing it. In other words,
this will convert to Number
from a Number
, Calendar
,
or Date
. If it can't do that, it will get the string value and have
toNumber(String,String,Locale)
try to parse it using the
default Locale and format.
obj
- - the object to convertpublic static Number toNumber(Object obj, boolean handleStrings)
toNumber(Object)
except that you can tell
this to attempt parsing the object as a String by passing true
as the second parameter. If you do so, then it will have
toNumber(String,String,Locale)
try to parse it using the
default Locale and format.
public static Number toNumber(String value, String format, Locale locale)
Number
using the
specified format and Locale
to parse it.
value
- - the string to convertformat
- - the format the number is inlocale
- - the Locale
Number
or null
if no
conversion is possibleNumberFormat.parse(java.lang.String, java.text.ParsePosition)
public static Number toNumber(Object value, String format, Locale locale)
Number
using the
specified format and Locale
to parse it, if necessary.
value
- - the object to convertformat
- - the format the number is inlocale
- - the Locale
Number
or null
if no
conversion is possibleNumberFormat.parse(java.lang.String, java.text.ParsePosition)
public static DateFormat getDateFormat(String format, Locale locale, TimeZone timezone)
DateFormat
instance for the specified
format, Locale
, and TimeZone
. If the format
specified is a standard style pattern, then a date-time instance
will be returned with both the date and time styles set to the
specified style. If it is a custom format, then a customized
SimpleDateFormat
will be returned.
format
- the custom or standard formatting pattern to be usedlocale
- the Locale
to be usedtimezone
- the TimeZone
to be used
DateFormat
SimpleDateFormat
,
DateFormat
public static DateFormat getDateFormat(String dateStyle, String timeStyle, Locale locale, TimeZone timezone)
DateFormat
instance for the specified
date style, time style, Locale
, and TimeZone
.
dateStyle
- the date styletimeStyle
- the time stylelocale
- the Locale
to be usedtimezone
- the TimeZone
to be used
DateFormat
getDateFormat(int timeStyle, int dateStyle, Locale locale, TimeZone timezone)
public static DateFormat getDateFormat(int dateStyle, int timeStyle, Locale locale, TimeZone timezone)
DateFormat
instance for the specified
time style, date style, Locale
, and TimeZone
.
dateStyle
- the date style (date will be ignored if this is
less than zero and the date style is not)timeStyle
- the time style (time will be ignored if this is
less than zero and the date style is not)locale
- the Locale
to be usedtimezone
- the TimeZone
to be used
DateFormat
or null
if an instance cannot be constructed with the given
parameterspublic static int getDateStyleAsInt(String style)
style
- the string to be checked
DateFormat
public static Date toDate(Object obj)
Object
into a Date
,
just short of turning it into a string and parsing it. In other words,
this will convert to Date
from a Date
, Calendar
,
or Number
. If it can't do that, it will return null
.
obj
- - the object to convertpublic static Date toDate(Object obj, String format, Locale locale, TimeZone timezone)
Date
using the
specified format, Locale
, and TimeZone
if the
object is not already an instance of Date, Calendar, or Long.
obj
- - the date to convertformat
- - the format the date is inlocale
- - the Locale
timezone
- - the TimeZone
Date
or null
if no
conversion is possiblegetDateFormat(java.lang.String, java.util.Locale, java.util.TimeZone)
,
SimpleDateFormat.parse(java.lang.String, java.text.ParsePosition)
public static Date toDate(String str, String format, Locale locale, TimeZone timezone)
Date
using the
specified format, Locale
, and TimeZone
if the
object is not already an instance of Date, Calendar, or Long.
str
- - the string to parseformat
- - the format the date is inlocale
- - the Locale
timezone
- - the TimeZone
Date
or null
if the
parsing failsgetDateFormat(java.lang.String, java.util.Locale, java.util.TimeZone)
,
SimpleDateFormat.parse(java.lang.String, java.text.ParsePosition)
public static Calendar toCalendar(Date date, Locale locale)
public static String toString(Object value)
value
- the object to be turned into a String
public static String toString(Collection values)
values
- the Collection to be turned into a string
public static Boolean toBoolean(Object value)
toString(Object)
and Boolean.valueOf(String)
.
value
- the object to be converted
Boolean
object for the specified value or
null
if the value is null or the conversion failedpublic static Locale toLocale(String value)
Locale
value
- - the string to parse
Locale
or null
if the
parsing failspublic static URL toURL(String value)
URL
. It will first try to
treat the string as a File name, then a classpath resource,
then finally as a literal URL. If none of these work, then
this will return null
.
value
- - the string to parse
URL
form of the string or null
File
,
ClassUtils.getResource(String,Object)
,
URL
public static URL toURL(String value, Object caller)
URL
. It will first try to
treat the string as a File name, then a classpath resource,
then finally as a literal URL. If none of these work, then
this will return null
.
value
- - the string to parsecaller
- - the object or Class seeking the url
URL
form of the string or null
File
,
ClassUtils.getResource(String,Object)
,
URL
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |