All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class cryptix.CryptixProperties

java.lang.Object
   |
   +----cryptix.CryptixProperties

public class CryptixProperties
extends Object
This class defines the version number of the Cryptix library, and also provides facilities needed to load and manage properties.

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.

The property values are read from a file called Cryptix.properties, which is stored in the Cryptix library directory.

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.

Property values loaded from Cryptix.properties are always read-only. They can be accessed by untrusted code, so should not be secret.

Copyright © 1997 Systemics Ltd on behalf of the Cryptix Development Team.
All rights reserved.

$Revision: 1.2 $

Author:
David Hopwood, Jill Baker, Raif S. Naffah

Method Index

 o getHtmlInfo()
Returns English-language HTML credits for Cryptix, in a form that could be included in an application's About box, for example.
 o getIntermediateVersion()
Returns the intermediate version of this release of Cryptix.
 o getLibraryPath()
Returns the path of the library directory.
 o getMajorVersion()
Returns the major version of this release of Cryptix.
 o getMinorVersion()
Returns the minor version of this release of Cryptix.
 o getProperty(String)
Gets the value of a property.
 o getProperty(String, String)
Gets the value of a property, or returns defaultValue if the property was not set.
 o getReleaseDate()
Returns the release date of this version of Cryptix, as a string in the form "yyyy/mm/dd".
 o getVersionString()
Returns a string describing this version of Cryptix.
 o isVersionAtLeast(int, int, int)
Returns true iff this version of Cryptix is at least the given version.
 o list(PrintStream)
Lists the properties to the PrintStream out.
 o list(PrintWriter)
Lists the properties to the PrintWriter out.
 o main(String[])
Prints the Cryptix version string, whether Cryptix is installed correctly, and the location of the library directory.
 o propertyNames()
Returns an enumeration of all the property names.
 o save(OutputStream, String)
Saves the properties to the OutputStream os, in the format used by java.util.Properties.save.

Methods

 o getMajorVersion
 public static int getMajorVersion()
Returns the major version of this release of Cryptix.

 o getMinorVersion
 public static int getMinorVersion()
Returns the minor version of this release of Cryptix.

 o getIntermediateVersion
 public static int getIntermediateVersion()
Returns the intermediate version of this release of Cryptix.

 o isVersionAtLeast
 public static boolean isVersionAtLeast(int major,
                                        int minor,
                                        int intermediate)
Returns true iff this version of Cryptix is at least the given version.

 o getReleaseDate
 public static String getReleaseDate()
Returns the release date of this version of Cryptix, as a string in the form "yyyy/mm/dd".

 o getVersionString
 public static String getVersionString()
Returns a string describing this version of Cryptix.

 o getHtmlInfo
 public static String getHtmlInfo()
Returns English-language HTML credits for Cryptix, in a form that could be included in an application's About box, for example.

The returned string does not have <HTML> or <BODY> tags, so that it can easily be included in a larger page.

 o main
 public static void main(String args[])
Prints the Cryptix version string, whether Cryptix is installed correctly, and the location of the library directory.

 o getLibraryPath
 public static String getLibraryPath() throws IOException
Returns the path of the library directory. The name of this directory is given by the LIB_DIRNAME constant.

The returned path is always absolute, and ends with a file separator character (e.g. "/" on Unix).

Throws: IOException
if an error occurred during intialization, preventing the path from being determined.
 o save
 public static void save(OutputStream os,
                         String comment)
Saves the properties to the OutputStream os, in the format used by java.util.Properties.save. The string comment is written as a comment in the first line of the output.

 o getProperty
 public static String getProperty(String key)
Gets the value of a property.

 o getProperty
 public static String getProperty(String key,
                                  String defaultValue)
Gets the value of a property, or returns defaultValue if the property was not set.

 o propertyNames
 public static Enumeration propertyNames()
Returns an enumeration of all the property names.

 o list
 public static void list(PrintStream out)
Lists the properties to the PrintStream out.

 o list
 public static void list(PrintWriter out)
Lists the properties to the PrintWriter out.


All Packages  Class Hierarchy  This Package  Previous  Next  Index