|
Server : Apache/2.2.2 (Fedora) System : Linux App1.pathumtani.go.th 2.6.20-1.2320.fc5smp #1 SMP Tue Jun 12 19:40:16 EDT 2007 i686 User : apache ( 48) PHP Version : 5.2.9 Disable Function : NONE Directory : /usr/share/javadoc/cryptix-3.2.0/cryptix/ |
Upload File : |
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE html PUBLIC "-//gnu.org///DTD XHTML 1.1 plus Target 1.0//EN" "../resources/xhtml11-target10.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><title>CryptixProperties (cryptix JavaDoc)</title><script src="../resources/gjdoc.js" type="text/javascript"><!-- this comment required for konqueror 3.2.2 --></script><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><meta name="generator" content="GNU Gjdoc Standard Doclet"/><meta name="keywords" content="cryptix.CryptixProperties class"/><meta name="keywords" content="NATIVE_ALLOWED"/><meta name="keywords" content="HTML_INFO"/><meta name="keywords" content="PRODUCT_NAME"/><meta name="keywords" content="LIB_DIRNAME"/><meta name="keywords" content="PROPERTIES_FILES"/><meta name="keywords" content="getMajorVersion()"/><meta name="keywords" content="getMinorVersion()"/><meta name="keywords" content="getIntermediateVersion()"/><meta name="keywords" content="isVersionAtLeast()"/><meta name="keywords" content="getReleaseDate()"/><meta name="keywords" content="getVersionString()"/><meta name="keywords" content="getHtmlInfo()"/><meta name="keywords" content="main()"/><meta name="keywords" content="getLibraryPath()"/><meta name="keywords" content="save()"/><meta name="keywords" content="getProperty()"/><meta name="keywords" content="propertyNames()"/><meta name="keywords" content="list()"/><link rel="stylesheet" type="text/css" href="../resources/gjdochtml-clean-layout.css" title="GNU Clean"/><link rel="stylesheet" type="text/css" href="../resources/gjdochtml-clean-color1.css" title="GNU Clean"/></head><body class="content class" onload="if(parent.contentPageLoaded)parent.contentPageLoaded(document.title)"><table class="navbar div top"><tr><td class="navbar div top"><div class="navbar div top"><span class="navbar item enabled"><a href="../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../about.html">About</a></span></div></td></tr><tr><td class="navi"><a href="../cryptix/CryptixException.html">Prev Class</a> | Next Class</td><td class="navi"><a href="../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="CryptixProperties.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | <a href="#summary-fields">Field</a> | <a href="#summary-methods">Method</a> | Constr</td><td class="navi">Detail: Nested | <a href="#detail-fields">Field</a> | <a href="#detail-methods">Method</a> | Constr</td></tr></table><div class="class title outer"><h3 class="class title-package">cryptix</h3><h1 class="class title-class">Class CryptixProperties</h1></div><div class="class inheritance-tree"><ul class="inheritance 0"><li class="inheritance 0"><code>java.lang.Object</code></li><li><ul class="inheritance 1"><li class="inheritance 1"><code>cryptix.CryptixProperties</code></li><li></li></ul></li></ul></div><hr/><div class="class synopsis outer"><div class="class synopsis declaration"><code>public class <b class="class synopsis name">CryptixProperties</b></code></div><div class="class synopsis superclass"><code>extends java.lang.Object</code></div></div><hr/><div class="class description"> This class defines the version number of the Cryptix library, and also
provides facilities needed to load and manage properties.
<ul><li> The major version is intended to signal significant
changes in compatibility or style.
</li><li> The minor version is intended to signal small changes
in compatibility and new, compatible additions.
</li><li> The intermediate version is incremented for bug-fix and alpha
releases.
</li></ul>
<p/>
Version numbers should be written as a triple of integers, not as a decimal.
If the last number is omitted it is assumed to be 0, so for example, version
1.10 is after version 1.2.
<p/>
The property values are read from files called
<a href="../src/cryptix-lib/Cryptix.properties"><samp>Cryptix.properties</samp></a>
and <samp>Local.properties</samp>, which are stored in the <i>Cryptix library
directory</i>.
The <samp>Local.properties</samp> file (if it exists) adds to and overrides
entries in <samp>Cryptix.properties</samp>, and is intended to be used for
local customisations by a user or adminstrator.
<p/>
The library directory is found by searching the current classpath. For
each classpath entry, a "cryptix-lib" subdirectory is looked for. If the
entry is a .zip or .jar file, "cryptix-lib" will be looked for in the
same directory as that file.
<p/>
Property values loaded from <samp>Cryptix.properties</samp> or
<samp>Local.properties</samp> are always read-only. They can be accessed by
untrusted code, so should not be secret.
<p/>
<b>Copyright</b> © 1997
<a href="http://www.systemics.com/">Systemics Ltd</a> on behalf of the
<a href="http://www.systemics.com/docs/cryptix/">Cryptix Development Team</a>.
<br/>All rights reserved.
<p/>
<b>$Revision: 1.13 $</b>
</div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Authors:</b></dt><dd class="tag item">David Hopwood</dd><dd class="tag item">Jill Baker</dd><dd class="tag item">Raif S. Naffah</dd></dl></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Since:</b></dt><dd>Cryptix 2.2.2</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><a name="summary-fields" id="summary-fields"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Field Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis">(package private) static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#HTML_INFO">HTML_INFO</a></code></dt><dd class="description"> An HTML description of the provider.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">(package private) static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#LIB_DIRNAME">LIB_DIRNAME</a></code></dt><dd class="description"> The name of the directory in which the properties files and (if
applicable) native libraries are found.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#NATIVE_ALLOWED">NATIVE_ALLOWED</a></code></dt><dd class="description"> If this constant is false, native linking is disabled regardless of
any settings in the properties files.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">(package private) static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#PRODUCT_NAME">PRODUCT_NAME</a></code></dt><dd class="description"> The common name for this class library.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">(package private) static String[]</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#PROPERTIES_FILES">PROPERTIES_FILES</a></code></dt><dd class="description"> The names of the properties files.</dd></dl></td></tr></table></dd></dl><a name="summary-methods" id="summary-methods"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Method Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis">static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getHtmlInfo()">getHtmlInfo</a>()</code></dt><dd class="description"> Returns English-language HTML credits for Cryptix, in a form that
could be included in an application's About box, for example.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getIntermediateVersion()">getIntermediateVersion</a>()</code></dt><dd class="description"> Returns the intermediate version of this release of Cryptix.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getLibraryPath()">getLibraryPath</a>()</code></dt><dd class="description"> Returns the path of the library directory.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getMajorVersion()">getMajorVersion</a>()</code></dt><dd class="description"> Returns the major version of this release of Cryptix.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getMinorVersion()">getMinorVersion</a>()</code></dt><dd class="description"> Returns the minor version of this release of Cryptix.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getProperty(String)">getProperty</a>(String key)</code></dt><dd class="description"> Gets the value of a property.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getProperty(String,String)">getProperty</a>(String key, String defaultValue)</code></dt><dd class="description"> Gets the value of a property, or returns <i>defaultValue</i> if the
property was not set.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getReleaseDate()">getReleaseDate</a>()</code></dt><dd class="description"> Returns the release date of this version of Cryptix, as a string in
the form "yyyy/mm/dd".</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getVersionString()">getVersionString</a>()</code></dt><dd class="description"> Returns a string describing this version of Cryptix.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#isVersionAtLeast(int,int,int)">isVersionAtLeast</a>(int major, int minor, int intermediate)</code></dt><dd class="description"> Returns true iff this version of Cryptix is at least the given
version.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#list(PrintStream)">list</a>(PrintStream out)</code></dt><dd class="description"> Lists the properties to the PrintStream <i>out</i>.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#list(PrintWriter)">list</a>(PrintWriter out)</code></dt><dd class="description"> Lists the properties to the PrintWriter <i>out</i>.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#main(String[])">main</a>(String[] args)</code></dt><dd class="description"> Prints the Cryptix version string, whether Cryptix is installed correctly,
and the location of the library directory.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static Enumeration</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#propertyNames()">propertyNames</a>()</code></dt><dd class="description"> Returns an enumeration of all the property names.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#save(OutputStream,String)">save</a>(OutputStream os, String comment)</code></dt><dd class="description"> Saves the properties to the OutputStream <i>os</i>, in the format
used by <code>java.util.Properties.save</code>.</dd></dl></td></tr></table></dd></dl><a name="detail-fields" id="detail-fields"/><h2 class="section header">Field Details</h2><div class="section"><a name="HTML_INFO" id="HTML_INFO"/><div class="member detail outer"><h3 class="member detail name">HTML_INFO</h3><pre class="member detail synopsis">(package private) static final String HTML_INFO</pre><blockquote class="member detail name"><div class="member detail description"> An HTML description of the provider.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="LIB_DIRNAME" id="LIB_DIRNAME"/><div class="member detail outer"><h3 class="member detail name">LIB_DIRNAME</h3><pre class="member detail synopsis">(package private) static final String LIB_DIRNAME</pre><blockquote class="member detail name"><div class="member detail description"> The name of the directory in which the properties files and (if
applicable) native libraries are found.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="NATIVE_ALLOWED" id="NATIVE_ALLOWED"/><div class="member detail outer"><h3 class="member detail name">NATIVE_ALLOWED</h3><pre class="member detail synopsis">public static final boolean NATIVE_ALLOWED</pre><blockquote class="member detail name"><div class="member detail description"> If this constant is false, native linking is disabled regardless of
any settings in the properties files.
</div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Field Value:</b></dt><dd class="member detail thrown item">true</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="PRODUCT_NAME" id="PRODUCT_NAME"/><div class="member detail outer"><h3 class="member detail name">PRODUCT_NAME</h3><pre class="member detail synopsis">(package private) static final String PRODUCT_NAME</pre><blockquote class="member detail name"><div class="member detail description"> The common name for this class library. This is used for error messages,
because most of the code for this class is duplicated between Cryptix
and IJCE.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="PROPERTIES_FILES" id="PROPERTIES_FILES"/><div class="member detail outer"><h3 class="member detail name">PROPERTIES_FILES</h3><pre class="member detail synopsis">(package private) static final String[] PROPERTIES_FILES</pre><blockquote class="member detail name"><div class="member detail description"> The names of the properties files.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="getHtmlInfo()" id="getHtmlInfo()"/><div class="member detail outer"><h3 class="member detail name">getHtmlInfo</h3><pre class="member detail synopsis">public static String getHtmlInfo()</pre><blockquote class="member detail name"><div class="member detail description"> Returns English-language HTML credits for Cryptix, in a form that
could be included in an application's About box, for example.
<p/>
The returned string does not have <HTML> or <BODY> tags,
so that it can easily be included in a larger page.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getIntermediateVersion()" id="getIntermediateVersion()"/><div class="member detail outer"><h3 class="member detail name">getIntermediateVersion</h3><pre class="member detail synopsis">public static int getIntermediateVersion()</pre><blockquote class="member detail name"><div class="member detail description"> Returns the intermediate version of this release of Cryptix.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getLibraryPath()" id="getLibraryPath()"/><div class="member detail outer"><h3 class="member detail name">getLibraryPath</h3><pre class="member detail synopsis">public static String getLibraryPath()
throws IOException</pre><blockquote class="member detail name"><div class="member detail description"> Returns the path of the library directory. The name of this directory
is given by the LIB_DIRNAME constant.
<p/>
The returned path is always absolute, and ends with a file separator
character (e.g. "/" on Unix).
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getMajorVersion()" id="getMajorVersion()"/><div class="member detail outer"><h3 class="member detail name">getMajorVersion</h3><pre class="member detail synopsis">public static int getMajorVersion()</pre><blockquote class="member detail name"><div class="member detail description"> Returns the major version of this release of Cryptix.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getMinorVersion()" id="getMinorVersion()"/><div class="member detail outer"><h3 class="member detail name">getMinorVersion</h3><pre class="member detail synopsis">public static int getMinorVersion()</pre><blockquote class="member detail name"><div class="member detail description"> Returns the minor version of this release of Cryptix.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getProperty(String)" id="getProperty(String)"/><div class="member detail outer"><h3 class="member detail name">getProperty</h3><pre class="member detail synopsis">public static String getProperty(String key)</pre><blockquote class="member detail name"><div class="member detail description"> Gets the value of a property.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getProperty(String,String)" id="getProperty(String,String)"/><div class="member detail outer"><h3 class="member detail name">getProperty</h3><pre class="member detail synopsis">public static String getProperty(String key,
String defaultValue)</pre><blockquote class="member detail name"><div class="member detail description"> Gets the value of a property, or returns <i>defaultValue</i> if the
property was not set.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getReleaseDate()" id="getReleaseDate()"/><div class="member detail outer"><h3 class="member detail name">getReleaseDate</h3><pre class="member detail synopsis">public static String getReleaseDate()</pre><blockquote class="member detail name"><div class="member detail description"> Returns the release date of this version of Cryptix, as a string in
the form "yyyy/mm/dd".
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getVersionString()" id="getVersionString()"/><div class="member detail outer"><h3 class="member detail name">getVersionString</h3><pre class="member detail synopsis">public static String getVersionString()</pre><blockquote class="member detail name"><div class="member detail description"> Returns a string describing this version of Cryptix.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="isVersionAtLeast(int,int,int)" id="isVersionAtLeast(int,int,int)"/><div class="member detail outer"><h3 class="member detail name">isVersionAtLeast</h3><pre class="member detail synopsis">public static boolean isVersionAtLeast(int major,
int minor,
int intermediate)</pre><blockquote class="member detail name"><div class="member detail description"> Returns true iff this version of Cryptix is at least the given
version.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="list(PrintStream)" id="list(PrintStream)"/><div class="member detail outer"><h3 class="member detail name">list</h3><pre class="member detail synopsis">public static void list(PrintStream out)</pre><blockquote class="member detail name"><div class="member detail description"> Lists the properties to the PrintStream <i>out</i>.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="list(PrintWriter)" id="list(PrintWriter)"/><div class="member detail outer"><h3 class="member detail name">list</h3><pre class="member detail synopsis">public static void list(PrintWriter out)</pre><blockquote class="member detail name"><div class="member detail description"> Lists the properties to the PrintWriter <i>out</i>.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="main(String[])" id="main(String[])"/><div class="member detail outer"><h3 class="member detail name">main</h3><pre class="member detail synopsis">public static void main(String[] args)</pre><blockquote class="member detail name"><div class="member detail description"> Prints the Cryptix version string, whether Cryptix is installed correctly,
and the location of the library directory.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="propertyNames()" id="propertyNames()"/><div class="member detail outer"><h3 class="member detail name">propertyNames</h3><pre class="member detail synopsis">public static Enumeration propertyNames()</pre><blockquote class="member detail name"><div class="member detail description"> Returns an enumeration of all the property names.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="save(OutputStream,String)" id="save(OutputStream,String)"/><div class="member detail outer"><h3 class="member detail name">save</h3><pre class="member detail synopsis">public static void save(OutputStream os,
String comment)</pre><blockquote class="member detail name"><div class="member detail description"> Saves the properties to the OutputStream <i>os</i>, in the format
used by <code>java.util.Properties.save</code>. The string <i>comment</i>
is written as a comment in the first line of the output.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><p class="navbar bottom spacer"> </p><table class="navbar div bottom"><tr><td><div class="navbar div top"><span class="navbar item enabled"><a href="../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../about.html">About</a></span></div></td></tr></table></body></html>