001/*
002 * Copyright 2002-2012 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.format;
018
019import java.text.ParseException;
020import java.util.Locale;
021
022/**
023 * Parses text strings to produce instances of T.
024 *
025 * @author Keith Donald
026 * @since 3.0
027 * @param <T> the type of object this Parser produces
028 */
029public interface Parser<T> {
030
031        /**
032         * Parse a text String to produce a T.
033         * @param text the text string
034         * @param locale the current user locale
035         * @return an instance of T
036         * @throws ParseException when a parse exception occurs in a java.text parsing library
037         * @throws IllegalArgumentException when a parse exception occurs
038         */
039        T parse(String text, Locale locale) throws ParseException;
040
041}