001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      https://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.lang3.time;
018
019import java.text.ParseException;
020import java.text.ParsePosition;
021import java.util.Calendar;
022import java.util.Date;
023import java.util.Locale;
024import java.util.TimeZone;
025
026/**
027 * DateParser is the "missing" interface for the parsing methods of
028 * {@link java.text.DateFormat}. You can obtain an object implementing this
029 * interface by using one of the FastDateFormat factory methods.
030 * <p>
031 * Warning: Since binary compatible methods may be added to this interface in any
032 * release, developers are not expected to implement this interface.
033 * </p>
034 *
035 * @since 3.2
036 */
037public interface DateParser {
038
039    /**
040     * Gets the locale used by this parser.
041     *
042     * @return the locale
043     */
044    Locale getLocale();
045
046    /**
047     * Gets the pattern used by this parser.
048     *
049     * @return the pattern, {@link java.text.SimpleDateFormat} compatible.
050     */
051    String getPattern();
052
053    /**
054     * Gets the time zone used by this parser.
055     *
056     * <p>
057     * The default {@link TimeZone} used to create a {@link Date} when the {@link TimeZone} is not specified by
058     * the format pattern.
059     * </p>
060     *
061     * @return the time zone
062     */
063    TimeZone getTimeZone();
064
065    /**
066     * Equivalent to DateFormat.parse(String).
067     *
068     * See {@link java.text.DateFormat#parse(String)} for more information.
069     *
070     * @param source A {@link String} whose beginning should be parsed.
071     * @return A {@link Date} parsed from the string.
072     * @throws ParseException if the beginning of the specified string cannot be parsed.
073     */
074    Date parse(String source) throws ParseException;
075
076    /**
077     * Equivalent to DateFormat.parse(String, ParsePosition).
078     *
079     * See {@link java.text.DateFormat#parse(String, ParsePosition)} for more information.
080     *
081     * @param source A {@link String}, part of which should be parsed.
082     * @param pos A {@link ParsePosition} object with index and error index information
083     * as described above.
084     * @return A {@link Date} parsed from the string. In case of error, returns null.
085     * @throws NullPointerException if text or pos is null.
086     */
087    Date parse(String source, ParsePosition pos);
088
089    /**
090     * Parses a formatted date string according to the format.  Updates the Calendar with parsed fields.
091     * Upon success, the ParsePosition index is updated to indicate how much of the source text was consumed.
092     * Not all source text needs to be consumed.  Upon parse failure, ParsePosition error index is updated to
093     * the offset of the source text which does not match the supplied format.
094     *
095     * @param source The text to parse.
096     * @param pos On input, the position in the source to start parsing, on output, updated position.
097     * @param calendar The calendar into which to set parsed fields.
098     * @return true, if source has been parsed (pos parsePosition is updated); otherwise false (and pos errorIndex is updated)
099     * @throws IllegalArgumentException when Calendar has been set to be not lenient, and a parsed field is
100     * out of range.
101     *
102     * @since 3.5
103     */
104    boolean parse(String source, ParsePosition pos, Calendar calendar);
105
106    /**
107     * Parses text from a string to produce a Date.
108     *
109     * @param source A {@link String} whose beginning should be parsed.
110     * @return a {@link java.util.Date} object.
111     * @throws ParseException if the beginning of the specified string cannot be parsed.
112     * @see java.text.DateFormat#parseObject(String)
113     */
114    Object parseObject(String source) throws ParseException;
115
116    /**
117     * Parses a date/time string according to the given parse position.
118     *
119     * @param source A {@link String} whose beginning should be parsed.
120     * @param pos the parse position.
121     * @return a {@link java.util.Date} object.
122     * @see java.text.DateFormat#parseObject(String, ParsePosition)
123     */
124    Object parseObject(String source, ParsePosition pos);
125}