/**
 * Multimud Helper.
 * 
 * Copyright (C) 2009 Benjamin Lerman<br>
 * Copyright (C) 2009 Jacques ???
 * 
 * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any later version.
 * 
 * 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 for more details.
 * 
 * You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
package net.ambre.multimud_helper.parser;

import java.util.SortedSet;

import net.ambre.multimud_helper.bean.TrainedSkill;

/**
 * parser for skills.
 */
public interface TrainedSkillParser {

    /**
     * parse the line of a skill and return the corresponding {@link TrainedSkill}.
     * 
     * @param trainedSkill the string representation of the {@link TrainedSkill}.
     * @return the {@link TrainedSkill} corresponding to the given string.
     */
    public TrainedSkill parseTrainedSkill(String trainedSkill);

    /**
     * parse the lines of skills and return the {@link SortedSet} of corresponding {@link TrainedSkill}.
     * 
     * @param trainedSkills the string representation of the {@link TrainedSkill}s.
     * @return the {@link SortedSet} of {@link TrainedSkill}s corresponding to the given string.
     */
    public SortedSet<TrainedSkill> parseTrainedSkills(String trainedSkills);
}