/* * BioJava development code * * This code may be freely distributed and modified under the * terms of the GNU Lesser General Public Licence. This should * be distributed with the code. If you do not have a copy, * see: * * http://www.gnu.org/copyleft/lesser.html * * Copyright for this code is held jointly by the individual * authors. These should be listed in @author doc comments. * * For more information on the BioJava project and its aims, * or to join the biojava-l mailing list, visit the home page * at: * * http://www.biojava.org/ * */ package org.biojava.bio.program.tagvalue; import org.biojava.utils.ParserException; /** *
* Tokenize single records (lines of text, objects) into a tag and a value. *
* ** TagValueParser instances may be stateful, that is they may remember * previous values of tags or values, and return different TagValue responses * accordingly. *
* * @author Matthew Pocock * @author Keith James * @since 1.2 */ public interface TagValueParser { /** *EMPTY_LINE_EOR
is a special EOR value which
* allows an empty line to be used as a record separator. Normally
* this is not possible as the empty line will be swallowed by the
* preceding tag or value. Use this as an argument to the
* setEndOfRecord
method.
An empty line is defined as a line which contains nothing * between the start and the following system-defined line * separator. Therefore lines which contain only whitespace are * not considererd to be empty.
*/ public static final String EMPTY_LINE_EOR = ""; public TagValue parse(Object record) throws ParserException; }