<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.5.0) on Wed Nov 22 10:48:21 MSK 2006 --> <TITLE> FileType </TITLE> <META NAME="keywords" CONTENT="net.sf.colorer.FileType class"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { parent.document.title="FileType"; } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> PREV CLASS <A HREF="../../../net/sf/colorer/Group.html" title="class in net.sf.colorer"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?net/sf/colorer/FileType.html" target="_top"><B>FRAMES</B></A> <A HREF="FileType.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> net.sf.colorer</FONT> <BR> Class FileType</H2> <PRE> java.lang.Object <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>net.sf.colorer.FileType</B> </PRE> <HR> <DL> <DT><PRE>public class <B>FileType</B><DT>extends java.lang.Object</DL> </PRE> <P> HRC FileType (or prototype) instance <P> <P> <HR> <P> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../net/sf/colorer/Scheme.html" title="class in net.sf.colorer">Scheme</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../net/sf/colorer/FileType.html#getBaseScheme()">getBaseScheme</A></B>()</CODE> <BR> Returns the base scheme of this file type.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../net/sf/colorer/FileType.html#getDescription()">getDescription</A></B>()</CODE> <BR> Public description of file type (HRC 'description' attribute)</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../net/sf/colorer/FileType.html#getGroup()">getGroup</A></B>()</CODE> <BR> Public group name of file type (HRC 'group' attribute)</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../net/sf/colorer/FileType.html#getName()">getName</A></B>()</CODE> <BR> Public name of file type (HRC 'name' attribute)</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../net/sf/colorer/FileType.html#getParameterDefaultValue(java.lang.String)">getParameterDefaultValue</A></B>(java.lang.String name)</CODE> <BR> Returns parameter's default value of this file type.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../net/sf/colorer/FileType.html#getParameterDescription(java.lang.String)">getParameterDescription</A></B>(java.lang.String name)</CODE> <BR> Retrieves parameter's user description string</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../net/sf/colorer/FileType.html#getParameters()">getParameters</A></B>()</CODE> <BR> Returns all available parameters for this file type.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../net/sf/colorer/FileType.html#getParameterValue(java.lang.String)">getParameterValue</A></B>(java.lang.String name)</CODE> <BR> Returns parameter's value of this file type.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../net/sf/colorer/FileType.html#setParameterValue(java.lang.String, java.lang.String)">setParameterValue</A></B>(java.lang.String name, java.lang.String value)</CODE> <BR> Changes value of the parameter with specified name.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> </TR> </TABLE> <P> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="getName()"><!-- --></A><H3> getName</H3> <PRE> public java.lang.String <B>getName</B>()</PRE> <DL> <DD>Public name of file type (HRC 'name' attribute) <P> <DD><DL> <DT><B>Returns:</B><DD>File type Name</DL> </DD> </DL> <HR> <A NAME="getGroup()"><!-- --></A><H3> getGroup</H3> <PRE> public java.lang.String <B>getGroup</B>()</PRE> <DL> <DD>Public group name of file type (HRC 'group' attribute) <P> <DD><DL> <DT><B>Returns:</B><DD>File type Group</DL> </DD> </DL> <HR> <A NAME="getDescription()"><!-- --></A><H3> getDescription</H3> <PRE> public java.lang.String <B>getDescription</B>()</PRE> <DL> <DD>Public description of file type (HRC 'description' attribute) <P> <DD><DL> <DT><B>Returns:</B><DD>File type Description</DL> </DD> </DL> <HR> <A NAME="getBaseScheme()"><!-- --></A><H3> getBaseScheme</H3> <PRE> public <A HREF="../../../net/sf/colorer/Scheme.html" title="class in net.sf.colorer">Scheme</A> <B>getBaseScheme</B>()</PRE> <DL> <DD>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. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getParameters()"><!-- --></A><H3> getParameters</H3> <PRE> public java.lang.String[] <B>getParameters</B>()</PRE> <DL> <DD>Returns all available parameters for this file type. Each element in enumeration contains a reference to parameter name. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getParameterDescription(java.lang.String)"><!-- --></A><H3> getParameterDescription</H3> <PRE> public java.lang.String <B>getParameterDescription</B>(java.lang.String name)</PRE> <DL> <DD>Retrieves parameter's user description string <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>name</CODE> - <DT><B>Returns:</B><DD></DL> </DD> </DL> <HR> <A NAME="getParameterValue(java.lang.String)"><!-- --></A><H3> getParameterValue</H3> <PRE> public java.lang.String <B>getParameterValue</B>(java.lang.String name)</PRE> <DL> <DD>Returns parameter's value of this file type. Parameters are stored in prototypes as <pre> \<parameters> \<param name="name" value="value" description="..."/> \</parameter> </pre> Parameters can be used to store application specific information about each type of file. Also parameters are accessible from the HRC definition using <code>if/unless</code> attributes of scheme elements. This allows portable customization of HRC loading. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>name</CODE> - Parameter's name <DT><B>Returns:</B><DD>Value (changed or default) of this parameter</DL> </DD> </DL> <HR> <A NAME="getParameterDefaultValue(java.lang.String)"><!-- --></A><H3> getParameterDefaultValue</H3> <PRE> public java.lang.String <B>getParameterDefaultValue</B>(java.lang.String name)</PRE> <DL> <DD>Returns parameter's default value of this file type. Default values are the values, explicitly pointed with \c value attribute. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>name</CODE> - Parameter's name <DT><B>Returns:</B><DD>Default value of this parameter</DL> </DD> </DL> <HR> <A NAME="setParameterValue(java.lang.String, java.lang.String)"><!-- --></A><H3> setParameterValue</H3> <PRE> public void <B>setParameterValue</B>(java.lang.String name, java.lang.String value)</PRE> <DL> <DD>Changes value of the parameter with specified name. Note, that changed parameter values are not stored in HRC base - they remains active only during this HRC session. Application should use its own mechanism to save these values between sessions (if needed). <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>name</CODE> - Parameter's name<DD><CODE>value</CODE> - New value of this parameter.</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> PREV CLASS <A HREF="../../../net/sf/colorer/Group.html" title="class in net.sf.colorer"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?net/sf/colorer/FileType.html" target="_top"><B>FRAMES</B></A> <A HREF="FileType.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> <i>Copyright © 2003 Cail Lomecb. All Rights Reserved.</i> </BODY> </HTML>