ReadlineLibrary.html 12.3 KB
Newer Older
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
2 3 4
<!--NewPage-->
<HTML>
<HEAD>
5
<!-- Generated by javadoc on Wed Aug 27 15:55:58 EST 2003 -->
6
<TITLE>
7
ReadlineLibrary (The Java-Readline Library)
8
</TITLE>
9
<META NAME="keywords" CONTENT="org.gnu.readline.ReadlineLibrary,ReadlineLibrary class">
10 11
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
12 13 14 15 16 17 18
<SCRIPT>
function asd()
{
parent.document.title="ReadlineLibrary (The Java-Readline Library)";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();">
19 20 21 22 23

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
24
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
25 26 27 28 29 30 31 32 33 34 35 36 37 38
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39
<strong>The Java-Readline Library, Version 0.8.0</strong></EM>
40 41 42 43 44 45 46 47 48
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/gnu/readline/Readline.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/gnu/readline/ReadlineReader.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
49 50 51 52 53 54 55 56 57 58 59 60 61
&nbsp;<A HREF="ReadlineLibrary.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;
<SCRIPT>
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
62 63 64
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
66
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
68 69 70 71 72 73 74 75 76 77
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.gnu.readline</FONT>
<BR>
78
Class ReadlineLibrary</H2>
79 80 81 82 83 84 85 86 87 88 89
<PRE>
java.lang.Object
  |
  +--<B>org.gnu.readline.ReadlineLibrary</B>
</PRE>
<HR>
<DL>
<DT>public final class <B>ReadlineLibrary</B><DT>extends java.lang.Object</DL>

<P>
This class implements a typesafe enumeration of the backing libraries.
90 91
<P>

92 93
<P>
<DL>
94 95 96 97
<DT><B>Version:</B></DT>
  <DD>$Revision: 1.4 $</DD>
<DT><B>Author:</B></DT>
  <DD>$Author: bablokb $</DD>
98 99 100 101
</DL>
<HR>

<P>
102
<!-- ======== NESTED CLASS SUMMARY ======== -->
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123


<!-- =========== FIELD SUMMARY =========== -->

<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../org/gnu/readline/ReadlineLibrary.html">ReadlineLibrary</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/gnu/readline/ReadlineLibrary.html#Editline">Editline</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant for Editline implementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../org/gnu/readline/ReadlineLibrary.html">ReadlineLibrary</A></CODE></FONT></TD>
124 125 126 127 128 129 130 131
<TD><CODE><B><A HREF="../../../org/gnu/readline/ReadlineLibrary.html#Getline">Getline</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant for Getline implementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../org/gnu/readline/ReadlineLibrary.html">ReadlineLibrary</A></CODE></FONT></TD>
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
<TD><CODE><B><A HREF="../../../org/gnu/readline/ReadlineLibrary.html#GnuReadline">GnuReadline</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant for GNU-Readline implementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../org/gnu/readline/ReadlineLibrary.html">ReadlineLibrary</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/gnu/readline/ReadlineLibrary.html#PureJava">PureJava</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant for fallback, pure Java implementation.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->


<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../org/gnu/readline/ReadlineLibrary.html">ReadlineLibrary</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/gnu/readline/ReadlineLibrary.html#byName(java.lang.String)">byName</A></B>(java.lang.String&nbsp;name)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return ReadlineLibrary-object with given name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/gnu/readline/ReadlineLibrary.html#getName()">getName</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Query name of backing library.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="PureJava"><!-- --></A><H3>
PureJava</H3>
<PRE>
public static final <A HREF="../../../org/gnu/readline/ReadlineLibrary.html">ReadlineLibrary</A> <B>PureJava</B></PRE>
<DL>
202 203 204 205 206
<DD>Constant for fallback, pure Java implementation.
<P>
<DL>
</DL>
</DL>
207 208 209 210 211 212 213
<HR>

<A NAME="GnuReadline"><!-- --></A><H3>
GnuReadline</H3>
<PRE>
public static final <A HREF="../../../org/gnu/readline/ReadlineLibrary.html">ReadlineLibrary</A> <B>GnuReadline</B></PRE>
<DL>
214 215 216 217 218
<DD>Constant for GNU-Readline implementation.
<P>
<DL>
</DL>
</DL>
219 220 221 222 223 224 225
<HR>

<A NAME="Editline"><!-- --></A><H3>
Editline</H3>
<PRE>
public static final <A HREF="../../../org/gnu/readline/ReadlineLibrary.html">ReadlineLibrary</A> <B>Editline</B></PRE>
<DL>
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
<DD>Constant for Editline implementation.
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="Getline"><!-- --></A><H3>
Getline</H3>
<PRE>
public static final <A HREF="../../../org/gnu/readline/ReadlineLibrary.html">ReadlineLibrary</A> <B>Getline</B></PRE>
<DL>
<DD>Constant for Getline implementation.
<P>
<DL>
</DL>
</DL>
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261

<!-- ========= CONSTRUCTOR DETAIL ======== -->


<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
public java.lang.String <B>getName</B>()</PRE>
<DL>
262 263 264 265
<DD>Query name of backing library.
<P>
<DD><DL>

266
<DT><B>Returns:</B><DD>Name of backing library, or "PureJava", in case fallback
267
     implementation is used.</DL>
268 269 270 271 272 273 274 275 276
</DD>
</DL>
<HR>

<A NAME="byName(java.lang.String)"><!-- --></A><H3>
byName</H3>
<PRE>
public static <A HREF="../../../org/gnu/readline/ReadlineLibrary.html">ReadlineLibrary</A> <B>byName</B>(java.lang.String&nbsp;name)</PRE>
<DL>
277 278 279 280
<DD>Return ReadlineLibrary-object with given name.
<P>
<DD><DL>

281 282 283 284 285 286 287 288 289 290
<DT><B>Returns:</B><DD>one of the predefined constants</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
291
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
292 293 294 295 296 297 298 299 300 301 302 303 304 305
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
306
<strong>The Java-Readline Library, Version 0.8.0</strong></EM>
307 308 309 310 311 312 313 314 315
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/gnu/readline/Readline.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/gnu/readline/ReadlineReader.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
316 317 318 319 320 321 322 323 324 325 326 327 328
&nbsp;<A HREF="ReadlineLibrary.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;
<SCRIPT>
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
329 330 331
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
332
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
333
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
334
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
335 336 337 338 339
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
340
Released under the LGPL, (c) Bernhard Bablok, Henner Zeller 1998-2002<br>Homepage: <a href=http://java-readline.sourceforge.net/>http://java-readline.sourceforge.net/</a>
341 342
</BODY>
</HTML>