Open Source Repository

Home /spring/spring-context-3.0.5 | Repository Home


org/springframework/format/Parser.java
/*
 * Copyright 2002-2009 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.format;

import java.text.ParseException;
import java.util.Locale;

/**
 * Parses text strings to produce instances of T.
 *
 @author Keith Donald
 @since 3.0 
 @param <T> the type of object this Parser produces
 */
public interface Parser<T> {

  /**
   * Parse a text String to produce a T.
   @param text the text string
   @param locale the current user locale
   @return an instance of T
   @throws ParseException when a parse exception occurs in a java.text parsing library
   @throws IllegalArgumentException when a parse exception occurs
   */
  T parse(String text, Locale localethrows ParseException;

}