001/*
002 * Licensed under the Apache License, Version 2.0 (the "License");
003 * you may not use this file except in compliance with the License.
004 * You may obtain a copy of the License at
005 *
006 *     http://www.apache.org/licenses/LICENSE-2.0
007 *
008 * Unless required by applicable law or agreed to in writing, software
009 * distributed under the License is distributed on an "AS IS" BASIS,
010 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
011 * See the License for the specific language governing permissions and
012 * limitations under the License.
013 */
014package org.gbif.common.parsers.core;
015
016/**
017 * Generic interface to allow multiple parser implementations.
018 *
019 * @param <T> The output type of the parse operation
020 */
021public interface Parsable<T> {
022
023  /**
024   * Tries to parse the input and returns a {@link ParseResult} object.
025   * This should never return <code>null</code> as parse errors will be indicated in the returned object.
026   *
027   * @param input To parse
028   *
029   * @return The output result of the operation
030   */
031  ParseResult<T> parse(String input);
032}