jdk.text.DateFormatSymbols — clojure-interop/java.text 1.0.5

DateFormatSymbols is a public class for encapsulating localizable date-time formatting data, such as the names of the months, the names of the days of the week, and the time zone data. SimpleDateFormat uses DateFormatSymbols to encapsulate this information.

Typically you shouldn't use DateFormatSymbols directly. Rather, you are encouraged to create a date-time formatter with the DateFormat class's factory methods: getTimeInstance, getDateInstance, or getDateTimeInstance. These methods automatically create a DateFormatSymbols for the formatter so that you don't have to. After the formatter is created, you may modify its format pattern using the setPattern method. For more information about creating formatters using DateFormat's factory methods, see DateFormat.

If you decide to create a date-time formatter with a specific format pattern for a specific locale, you can do so with:

new SimpleDateFormat(aPattern, DateFormatSymbols.getInstance(aLocale)).

DateFormatSymbols objects are cloneable. When you obtain a DateFormatSymbols object, feel free to modify the date-time formatting data. For instance, you can replace the localized date-time format pattern characters with the ones that you feel easy to remember. Or you can change the representative cities to your favorite ones.

New DateFormatSymbols subclasses may be added to support SimpleDateFormat for date-time formatting for additional locales.

*get-available-locales clj

(*get-available-locales)

Returns an array of all locales for which the getInstance methods of this class can return localized instances. The returned array represents the union of locales supported by the Java runtime and by installed DateFormatSymbolsProvider implementations. It must contain at least a Locale instance equal to Locale.US.

returns: An array of locales for which localized DateFormatSymbols instances are available. - java.util.Locale[]

*get-instance clj

(*get-instance)

(*get-instance locale)

Gets the DateFormatSymbols instance for the specified locale. This method provides access to DateFormatSymbols instances for locales supported by the Java runtime itself as well as for those supported by installed DateFormatSymbolsProvider implementations.

locale - the given locale. - java.util.Locale

returns: a DateFormatSymbols instance. - java.text.DateFormatSymbols

throws: java.lang.NullPointerException - if locale is null

->date-format-symbols clj

(->date-format-symbols)

(->date-format-symbols locale)

Constructor.

Construct a DateFormatSymbols object by loading format data from resources for the given locale. This constructor can only construct instances for the locales supported by the Java runtime environment, not for those supported by installed DateFormatSymbolsProvider implementations. For full locale coverage, use the getInstance method.

locale - the desired locale - java.util.Locale

throws: java.util.MissingResourceException - if the resources for the specified locale cannot be found or cannot be loaded.

clone clj

(clone this)

Overrides Cloneable

returns: a clone of this instance. - java.lang.Object

equals clj

(equals this obj)

Override equals

obj - the reference object with which to compare. - java.lang.Object

returns: true if this object is the same as the obj argument; false otherwise. - boolean

get-am-pm-strings clj

(get-am-pm-strings this)

Gets ampm strings. For example: "AM" and "PM".

returns: the ampm strings. - java.lang.String[]

get-eras clj

(get-eras this)

Gets era strings. For example: "AD" and "BC".

returns: the era strings. - java.lang.String[]

get-local-pattern-chars clj

(get-local-pattern-chars this)

Gets localized date-time pattern characters. For example: 'u', 't', etc.

returns: the localized date-time pattern characters. - java.lang.String

get-months clj

(get-months this)

Gets month strings. For example: "January", "February", etc.

If the language requires different forms for formatting and stand-alone usages, this method returns month names in the formatting form. For example, the preferred month name for January in the Czech language is ledna in the formatting form, while it is leden in the stand-alone form. This method returns "ledna" in this case. Refer to the Calendar Elements in the Unicode Locale Data Markup Language (LDML) specification for more details.

returns: the month strings. - java.lang.String[]

get-short-months clj

(get-short-months this)

Gets short month strings. For example: "Jan", "Feb", etc.

If the language requires different forms for formatting and stand-alone usages, This method returns short month names in the formatting form. For example, the preferred abbreviation for January in the Catalan language is de gen. in the formatting form, while it is gen. in the stand-alone form. This method returns "de gen." in this case. Refer to the Calendar Elements in the Unicode Locale Data Markup Language (LDML) specification for more details.

returns: the short month strings. - java.lang.String[]

get-short-weekdays clj

(get-short-weekdays this)

Gets short weekday strings. For example: "Sun", "Mon", etc.

returns: the short weekday strings. Use Calendar.SUNDAY, Calendar.MONDAY, etc. to index the result array. - java.lang.String[]

get-weekdays clj

(get-weekdays this)

Gets weekday strings. For example: "Sunday", "Monday", etc.

returns: the weekday strings. Use Calendar.SUNDAY, Calendar.MONDAY, etc. to index the result array. - java.lang.String[]

get-zone-strings clj

(get-zone-strings this)

Gets time zone strings. Use of this method is discouraged; use TimeZone.getDisplayName() instead.

The value returned is a two-dimensional array of strings of size n by m, where m is at least 5. Each of the n rows is an entry containing the localized names for a single TimeZone. Each such row contains (with i ranging from 0..n-1):

zoneStrings[i][0] - time zone ID zoneStrings[i][1] - long name of zone in standard time zoneStrings[i][2] - short name of zone in standard time zoneStrings[i][3] - long name of zone in daylight saving time zoneStrings[i][4] - short name of zone in daylight saving time

The zone ID is not localized; it's one of the valid IDs of the TimeZone class that are not custom IDs. All other entries are localized names. If a zone does not implement daylight saving time, the daylight saving time names should not be used.

If setZoneStrings has been called on this DateFormatSymbols instance, then the strings provided by that call are returned. Otherwise, the returned array contains names provided by the Java runtime and by installed TimeZoneNameProvider implementations.

returns: the time zone strings. - java.lang.String[][]

hash-code clj

(hash-code this)

Override hashCode. Generates a hash code for the DateFormatSymbols object.

returns: a hash code value for this object. - int

set-am-pm-strings clj

(set-am-pm-strings this new-ampms)

Sets ampm strings. For example: "AM" and "PM".

new-ampms - the new ampm strings. - java.lang.String[]

set-eras clj

(set-eras this new-eras)

Sets era strings. For example: "AD" and "BC".

new-eras - the new era strings. - java.lang.String[]

set-local-pattern-chars clj

(set-local-pattern-chars this new-local-pattern-chars)

Sets localized date-time pattern characters. For example: 'u', 't', etc.

new-local-pattern-chars - the new localized date-time pattern characters. - java.lang.String

set-months clj

(set-months this new-months)

Sets month strings. For example: "January", "February", etc.

new-months - the new month strings. - java.lang.String[]

set-short-months clj

(set-short-months this new-short-months)

Sets short month strings. For example: "Jan", "Feb", etc.

new-short-months - the new short month strings. - java.lang.String[]

set-short-weekdays clj

(set-short-weekdays this new-short-weekdays)

Sets short weekday strings. For example: "Sun", "Mon", etc.

new-short-weekdays - the new short weekday strings. The array should be indexed by Calendar.SUNDAY, Calendar.MONDAY, etc. - java.lang.String[]

set-weekdays clj

(set-weekdays this new-weekdays)

Sets weekday strings. For example: "Sunday", "Monday", etc.

new-weekdays - the new weekday strings. The array should be indexed by Calendar.SUNDAY, Calendar.MONDAY, etc. - java.lang.String[]

set-zone-strings clj

(set-zone-strings this new-zone-strings)

Sets time zone strings. The argument must be a two-dimensional array of strings of size n by m, where m is at least 5. Each of the n rows is an entry containing the localized names for a single TimeZone. Each such row contains (with i ranging from 0..n-1):

zoneStrings[i][0] - time zone ID zoneStrings[i][1] - long name of zone in standard time zoneStrings[i][2] - short name of zone in standard time zoneStrings[i][3] - long name of zone in daylight saving time zoneStrings[i][4] - short name of zone in daylight saving time

The zone ID is not localized; it's one of the valid IDs of the TimeZone class that are not custom IDs. All other entries are localized names.

new-zone-strings - the new time zone strings. - java.lang.String[][]

throws: java.lang.IllegalArgumentException - if the length of any row in newZoneStrings is less than 5