net.time4j.Meridiem Maven / Gradle / Ivy
/*
* -----------------------------------------------------------------------
* Copyright © 2013-2017 Meno Hochschild, Represents the half day relative to noon.
*
* @author Meno Hochschild
*/
/*[deutsch]
* Repräsentiert vor- oder nachmittags.
*
* @author Meno Hochschild
*/
public enum Meridiem
implements ChronoCondition {
//~ Statische Felder/Initialisierungen --------------------------------
/**
* Marks the wall time from midnight (at start of day) until
* before noon (ante meridiem).
*
* The numerical value is {@code 0}.
*/
/*[deutsch]
* Bezeichnet die Uhrzeit ab Mitternacht bis vor dem Mittag
* (ante meridiem).
*
* Der numerische Wert ist {@code 0}.
*/
AM,
/**
* Marks the wall time at or after noon (post meridiem).
*
* The numerical value is {@code 1}.
*/
/*[deutsch]
* Bezeichnet die Uhrzeit nach oder gleich dem Mittag
* (post meridiem).
*
* Der numerische Wert ist {@code 1}.
*/
PM;
//~ Methoden ----------------------------------------------------------
/**
* Calculates the meridiem value dependent on given hour of day.
*
* @param hour ISO-hour in the range {@code 0 <= hour <= 24}
* @return half of day (ante meridiem or post meridiem)
* @throws IllegalArgumentException if the hour is out of range
* @see PlainTime#AM_PM_OF_DAY
*/
/*[deutsch]
* Ermittelt den Tagesabschnitt auf Basis der angegebenen
* Tagesstunde.
*
* @param hour ISO-hour in the range {@code 0 <= hour <= 24}
* @return half of day (ante meridiem or post meridiem)
* @throws IllegalArgumentException if the hour is out of range
* @see PlainTime#AM_PM_OF_DAY
*/
public static Meridiem ofHour(int hour) {
if ((hour >= 0) && (hour <= 24)) {
return (((hour < 12) || (hour == 24)) ? AM : PM);
} else {
throw new IllegalArgumentException(
"Hour of day out of range: " + hour);
}
}
/**
* Equivalent to the expression
* {@code getDisplayName(locale, TextWidth.WIDE, OutputContext.FORMAT)}.
*
* @param locale language of text to be printed
* @return localized text in given language
*/
/*[deutsch]
* Entspricht dem Ausdruck
* {@code getDisplayName(locale, TextWidth.WIDE, OutputContext.FORMAT)}.
*
* @param locale language of text to be printed
* @return localized text in given language
*/
public String getDisplayName(Locale locale) {
return this.getDisplayName(locale, TextWidth.WIDE, OutputContext.FORMAT);
}
/**
* Gets the description text dependent on the locale and style
* parameters.
*
* The second argument controls the width of description while the
* third argument is only relevant for languages which make a difference
* between stand-alone forms and embedded text forms (does not matter in
* English).
*
* @param locale language setting
* @param width text width
* @param context output context
* @return descriptive text for given locale and style (never {@code null})
* @since 3.35/4.30
*/
/*[deutsch]
* Liefert den sprachabhängigen Beschreibungstext.
*
* Über das zweite Argument kann gesteuert werden, ob eine kurze
* oder eine lange Form des Beschreibungstexts ausgegeben werden soll. Das
* ist besonders sinnvoll in Benutzeroberflächen, wo zwischen der
* Beschriftung und der detaillierten Erläuterung einer graphischen
* Komponente unterschieden wird. Das dritte Argument ist in Sprachen von
* Belang, die verschiedene grammatikalische Formen für die Ausgabe
* als alleinstehend oder eingebettet in formatierten Text kennen.
*
* @param locale language setting
* @param width text width
* @param context output context
* @return descriptive text for given locale and style (never {@code null})
* @since 3.35/4.30
*/
public String getDisplayName(
Locale locale,
TextWidth width,
OutputContext context
) {
return CalendarText.getIsoInstance(locale).getMeridiems(width, context).print(this);
}
/**
* Tries to interprete given text as AM/PM.
*
* The strings "am", "AM", "pm", "PM" are always understood.
*
* @param text the text to be parsed
* @param locale language setting
* @param width expected text width
* @param context expected output context
* @return the parsed meridiem if successful
* @throws ParseException if parsing fails
* @see #getDisplayName(Locale, TextWidth, OutputContext)
* @since 3.35/4.30
*/
/*[deutsch]
* Versucht, den angegebenen Text als AM/PM zu interpretieren.
*
* Die Ausdrücke "am", "AM", "pm", "PM"
* werden immer verstanden.
*
* @param text the text to be parsed
* @param locale language setting
* @param width expected text width
* @param context expected output context
* @return the parsed meridiem if successful
* @throws ParseException if parsing fails
* @see #getDisplayName(Locale, TextWidth, OutputContext)
* @since 3.35/4.30
*/
public static Meridiem parse(
CharSequence text,
Locale locale,
TextWidth width,
OutputContext context
) throws ParseException {
if (text.length() == 2) {
char c2 = text.charAt(1);
if (c2 == 'M' || c2 == 'm') {
char c1 = text.charAt(0);
if (c1 == 'A' || c1 == 'a') {
return Meridiem.AM;
} else if (c1 == 'P' || c1 == 'p') {
return Meridiem.PM;
}
}
}
ParsePosition pp = new ParsePosition(0);
Meridiem m = CalendarText.getIsoInstance(locale).getMeridiems(width, context).parse(text, pp, Meridiem.class);
if (m == null) {
throw new ParseException("Cannot parse: " + text, pp.getErrorIndex());
} else {
return m;
}
}
@Override
public boolean test(WallTime context) {
int hour = context.getHour();
return (
(this == AM)
? ((hour < 12) || (hour == 24))
: ((hour >= 12) && (hour < 24))
);
}
}