sfi.director.application.autodoc.ConfigFile Class Reference

List of all members.

---

Detailed Description

Config file meta information.

Public Member Functions
	ConfigFile (String host)
	ConfigFile (String host, String filenames)
	Construct from host name and a colon separated list of file names.
DocChapter	owner ()
	Accessor for attribute owner.
DocChapter	owner (DocChapter owner)
	Mutator for attribute owner.
String	ownerHeading ()
	Accessor for attribute ownerHeading.
String	ownerHeading (String ownerHeading)
	Mutator for attribute ownerHeading.
Vector	revisedAlternatives ()
	Get a Vector of possible file paths for this configuration file.
String	citeFile (int versions)
Vector	fileHistory ()
	Find all the file versions available in the configuration file store.
String	host ()
	Accessor for attribute host.
String	host (String host)
	Mutator for attribute host.
File	fileRoot ()
	Return the root directory of config files store for the current host.
Vector	pathAlternatives ()
	Accessor for attribute pathAlternatives.
void	addAlternative (String path)
	Add alternative to the list of possible file paths (.
void	addAlternative (String[] path)
	Add alternatives to the list of possible file paths (.
void	addAlternative (Vector path)
	Add alternatives to the list of possible file paths (.
void	addAlternativeSpec (String path)
	Add alternative to the list of possible file paths (.
void	rotate ()
	someone is attempting to replace this config file, so rename it.
Static Public Member Functions
static Vector	getFiles (String host, String filenames)
	given a host name and a (colon separated) list of filename, return a vector of config files at this location.
Protected Attributes
DocChapter	owner = null
	Chapter with a description of whoever owns this config file.
String	ownerHeading = null
	Short text of the file's owner.
Vector	revisedAlternatives = null
String	host = null
	The name of the host this config file is located on.
File	fileRoot = null
Vector	pathAlternatives = new Vector()
	possible paths this file might be found under
Static Protected Attributes
static final int	keepVersions = 20
static final long	keepFor = 365*24*3600*1000
Package Attributes
Vector	fileHistory = null

---

Constructor & Destructor Documentation

sfi.director.application.autodoc.ConfigFile.ConfigFile (  String  host  )

sfi.director.application.autodoc.ConfigFile.ConfigFile (  String  host, String  filenames )

Construct from host name and a colon separated list of file names.

---

Member Function Documentation

void sfi.director.application.autodoc.ConfigFile.addAlternative (  Vector  path  )

Add alternatives to the list of possible file paths (. See also: pathAlternatives())

void sfi.director.application.autodoc.ConfigFile.addAlternative (  String[]  path  )

Add alternatives to the list of possible file paths (. See also: pathAlternatives())

void sfi.director.application.autodoc.ConfigFile.addAlternative (  String  path  )

Add alternative to the list of possible file paths (. See also: pathAlternatives())

void sfi.director.application.autodoc.ConfigFile.addAlternativeSpec (  String  path  )

Add alternative to the list of possible file paths (. See also: pathAlternatives()). Multiple locations may be encoded in the argument, separated by colons.

String sfi.director.application.autodoc.ConfigFile.citeFile (  int  versions  )

Vector sfi.director.application.autodoc.ConfigFile.fileHistory (   )

Find all the file versions available in the configuration file store. Returns: a Vector of java.io.File objects, sorted by age (most recent first)

File sfi.director.application.autodoc.ConfigFile.fileRoot (   )

Return the root directory of config files store for the current host.

static Vector sfi.director.application.autodoc.ConfigFile.getFiles (  String  host, String  filenames )  [static]

given a host name and a (colon separated) list of filename, return a vector of config files at this location. If the config file specified is a file (the usual case), then exactly one ConfigFile is returned, if it is a directory, for each file within the directory a ConfigFile is created.

String sfi.director.application.autodoc.ConfigFile.host (  String  host  )

Mutator for attribute host. The name of the host this config file is located on.

String sfi.director.application.autodoc.ConfigFile.host (   )

Accessor for attribute host. The name of the host this config file is located on.

DocChapter sfi.director.application.autodoc.ConfigFile.owner (  DocChapter  owner  )

Mutator for attribute owner. Chapter with a description of whoever owns this config file.

DocChapter sfi.director.application.autodoc.ConfigFile.owner (   )

Accessor for attribute owner. Chapter with a description of whoever owns this config file.

String sfi.director.application.autodoc.ConfigFile.ownerHeading (  String  ownerHeading  )

Mutator for attribute ownerHeading. Short text of the file's owner.

String sfi.director.application.autodoc.ConfigFile.ownerHeading (   )

Accessor for attribute ownerHeading. Short text of the file's owner.

Vector sfi.director.application.autodoc.ConfigFile.pathAlternatives (   )

Accessor for attribute pathAlternatives. possible paths this file might be found under

Vector sfi.director.application.autodoc.ConfigFile.revisedAlternatives (   )

Get a Vector of possible file paths for this configuration file. This may but need not be the same list as pathAlternatives(): if one or more of the alternatives is found in the local configuration file store, then this file(s) will be listed in the returned Vector while the other paths are dropped. If none of the alternatives is found in the configuration file store, then the whole list of alternatives is being returned.

void sfi.director.application.autodoc.ConfigFile.rotate (   )

someone is attempting to replace this config file, so rename it.

---

Member Data Documentation

Vector sfi.director.application.autodoc.ConfigFile.fileHistory = null [package]

File sfi.director.application.autodoc.ConfigFile.fileRoot = null [protected]

String sfi.director.application.autodoc.ConfigFile.host = null [protected]

The name of the host this config file is located on.

final long sfi.director.application.autodoc.ConfigFile.keepFor = 365*24*3600*1000 [static, protected]

final int sfi.director.application.autodoc.ConfigFile.keepVersions = 20 [static, protected]

DocChapter sfi.director.application.autodoc.ConfigFile.owner = null [protected]

Chapter with a description of whoever owns this config file.

String sfi.director.application.autodoc.ConfigFile.ownerHeading = null [protected]

Short text of the file's owner.

Vector sfi.director.application.autodoc.ConfigFile.pathAlternatives = new Vector() [protected]

possible paths this file might be found under

Vector sfi.director.application.autodoc.ConfigFile.revisedAlternatives = null [protected]

---

The documentation for this class was generated from the following file:

• director/application/autodoc/ConfigFile.java

---