001/* 002 * Units of Measurement Library 003 * Copyright (c) 2005-2016, Jean-Marie Dautelle, Werner Keil, V2COM. 004 * 005 * All rights reserved. 006 * 007 * Redistribution and use in source and binary forms, with or without modification, 008 * are permitted provided that the following conditions are met: 009 * 010 * 1. Redistributions of source code must retain the above copyright notice, 011 * this list of conditions and the following disclaimer. 012 * 013 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions 014 * and the following disclaimer in the documentation and/or other materials provided with the distribution. 015 * 016 * 3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products 017 * derived from this software without specific prior written permission. 018 * 019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 020 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 021 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 022 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 023 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 026 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 028 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 029 */ 030package tec.uom.lib.common.function; 031 032import javax.measure.format.ParserException; 033 034/** 035 * Represents a function that parses an input value and produces an output. 036 * 037 * <p> 038 * This is a <a href= 039 * "http://docs.oracle.com/javase/8/docs/api/java/util/function/package-summary.html#package.description" 040 * >functional interface</a> whose functional method is {@link #parse()}. 041 * 042 * @author <a href="mailto:units@catmedia.us">Werner Keil</a> 043 * @version 1.0, 2016-10-13 044 * @param <I> 045 * the input 046 * @param <O> 047 * the output 048 * @see ParserException 049 */ 050//@FunctionalInterface 051public interface Parser<I, O> { 052 /** 053 * Parses the specified {@code I} to produce a {@code O}. 054 * @throws ParserException if any problem occurs while parsing the 055 * specified input (e.g. illegal syntax). 056 */ 057 O parse(I input) throws ParserException; 058}