/*
 * Portions Copyright  2000-2007 Sun Microsystems, Inc. All Rights
 * Reserved.  Use is subject to license terms.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version
 * 2 only, as published by the Free Software Foundation.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License version 2 for more details (a copy is
 * included at /legal/license.txt).
 * 
 * You should have received a copy of the GNU General Public License
 * version 2 along with this work; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 * 
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
 * Clara, CA 95054 or visit www.sun.com if you need additional
 * information or have any questions.
 */
package gov.nist.javax.sdp.parser;
import gov.nist.javax.sdp.fields.*;
import gov.nist.core.*;
/**
 * Key field parser.
 * @version 1.0
 */
public class KeyFieldParser extends SDPParser {

    /** 
     * Creates new KeyFieldParser.
     * @param keyField the key field string to be parsed
     */
    public KeyFieldParser(String keyField) {
        lexer = new Lexer("charLexer", keyField);
    }

    /** Default constructor. */
    protected KeyFieldParser() {
        super();
    }

    /**
     * Perform the key field parsing
     * @return the parsed key field
     * @exception ParseException if a parsing error occurs
     */
    public KeyField keyField() throws ParseException  {
        lexer.match('k');
        lexer.SPorHT();
        lexer.match('=');
        lexer.SPorHT();

        KeyField keyField = new KeyField();
        NameValue nameValue = nameValue();
        String name = nameValue.getName();
        String value =  (String) nameValue.getValue();

        keyField.setType(name);

        keyField.setKeyData(value);

        return keyField;

    }

    /**
     * Perform the key field parsing
     * @return the parsed key field
     * @exception ParseException if a parsing error occurs
     */
    public SDPField parse() throws ParseException {
        return keyField();
    }

}