package net.sf.colorer;

/** HRC FileType (or prototype) instance
    @ingroup colorer
*/
public class FileType{
  /** Public name of file type (HRC 'name' attribute)
      @return File type Name
  */
  public native String getName();
  /** Public group name of file type (HRC 'group' attribute)
      @return File type Group
  */
  public native String getGroup();
  /** Public description of file type (HRC 'description' attribute)
      @return File type Description
  */
  public native String getDescription();
  /** Returns the base scheme of this file type.
      Basically, this is the scheme with same public name, as it's type.
      @return File type base scheme, to be used as root scheme of text parsing.
  */
  public native Scheme getBaseScheme();
  /** Returns parameter value of this file type.
      Parameters are stored in prototypes as
      <pre>
      &lt;parameters>
        &lt;param name="name" value="value"/>
      &lt;/parameter>
      </pre>
      @note Parameters could be used to store client-application
            specific information about each type of file.
      @param name Parameter's name
  */
  public native String getParameter(String name);
};

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the Colorer Library.
 *
 * The Initial Developer of the Original Code is
 * Cail Lomecb <cail@nm.ru>.
 * Portions created by the Initial Developer are Copyright (C) 1999-2003
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */
