Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Cryptix V3.1
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## cryptix
Class 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.

- The major version is intended to signal significant changes in compatibility or style.
- The minor version is intended to signal small changes in compatibility and new, compatible additions.
- The intermediate version is incremented for bug-fix and alpha releases.

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 files called `Cryptix.properties` and `Local.properties`, which are stored in the Cryptix library directory. The `Local.properties` file (if it exists) adds to and overrides entries in `Cryptix.properties`, and is intended to be used for local customisations by a user or adminstrator.

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` or `Local.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.13 $

Since:
  Cryptix 2.2.2
Author:
  David Hopwood, Jill Baker, Raif S. Naffah

Field Summary
`static boolean` | `NATIVE_ALLOWED` If this constant is false, native linking is disabled regardless of any settings in the properties files.

Method Summary
`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.
`static int` | `getIntermediateVersion()` Returns the intermediate version of this release of Cryptix.
`static String` | `getLibraryPath()` Returns the path of the library directory.
`static int` | `getMajorVersion()` Returns the major version of this release of Cryptix.
`static int` | `getMinorVersion()` Returns the minor version of this release of Cryptix.
`static String` | `getProperty(String key)` Gets the value of a property.
`static String` | `getProperty(String key, String defaultValue)` Gets the value of a property, or returns defaultValue if the property was not set.
`static String` | `getReleaseDate()` Returns the release date of this version of Cryptix, as a string in the form "yyyy/mm/dd".
`static String` | `getVersionString()` Returns a string describing this version of Cryptix.
`static boolean` | `isVersionAtLeast(int major, int minor, int intermediate)` Returns true iff this version of Cryptix is at least the given version.
`static void` | `list(java.io.PrintStream out)` Lists the properties to the PrintStream out.
`static void` | `list(java.io.PrintWriter out)` Lists the properties to the PrintWriter out.
`static void` | `main(String[] args)` Prints the Cryptix version string, whether Cryptix is installed correctly, and the location of the library directory.
`static java.util.Enumeration` | `propertyNames()` Returns an enumeration of all the property names.
`static void` | `save(java.io.OutputStream os, String comment)` Saves the properties to the OutputStream os, in the format used by `java.util.Properties.save`.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### NATIVE_ALLOWED

    public static final boolean NATIVE_ALLOWED

  If this constant is false, native linking is disabled regardless of any settings in the properties files.

Method Detail

### getMajorVersion

    public static int getMajorVersion()

  Returns the major version of this release of Cryptix.

### getMinorVersion

    public static int getMinorVersion()

  Returns the minor version of this release of Cryptix.

### getIntermediateVersion

    public static int getIntermediateVersion()

  Returns the intermediate version of this release of Cryptix.

### isVersionAtLeast

    public static boolean isVersionAtLeast(int major,
                                           int minor,
                                           int intermediate)

  Returns true iff this version of Cryptix is at least the given version.

### getReleaseDate

    public static String getReleaseDate()

  Returns the release date of this version of Cryptix, as a string in the form "yyyy/mm/dd".

### getVersionString

    public static String getVersionString()

  Returns a string describing this version of Cryptix.

### 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.

### main

    public static void main(String[] args)

  Prints the Cryptix version string, whether Cryptix is installed correctly, and the location of the library directory.

### getLibraryPath

    public static String getLibraryPath()
                                 throws java.io.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:
    java.io.IOException - if an error occurred during intialization, preventing the path from being determined.

### save

    public static void save(java.io.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.

### getProperty

    public static String getProperty(String key)

  Gets the value of a property.

### getProperty

    public static String getProperty(String key,
                                     String defaultValue)

  Gets the value of a property, or returns defaultValue if the property was not set.

### propertyNames

    public static java.util.Enumeration propertyNames()

  Returns an enumeration of all the property names.

### list

    public static void list(java.io.PrintStream out)

  Lists the properties to the PrintStream out.

### list

    public static void list(java.io.PrintWriter out)

  Lists the properties to the PrintWriter out.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Cryptix V3.1
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright (C) 1995-2000 The Cryptix Foundation Ltd. All rights reserved.