org.erowid.masterdoc
Class InternalRepository

java.lang.Object
  org.erowid.masterdoc.Repository
      org.erowid.masterdoc.InternalRepository

public class InternalRepository

extends Repository

The settings for APIs that are to be generated.

Version:

: $Header: /cvsroot/sperowider/SPEROWIDER_MODULE/javasource/org/erowid/masterdoc/InternalRepository.java,v 1.5 2005/01/15 23:26:17 gurustu Exp $

Author:

: $Author: gurustu $

Constructor Summary

InternalRepository(String name, String shortDescription, String longDescription, String generalUrl)

Method Summary

void	addDependency(String name) Adds an internal dependency.
void	addDocDir(File path) Adds a document directory.
void	addSourcePath(File path) Adds a source path
LinkedList	getDependencies() Returns the internal dependencies for this repository.
LinkedList	getDocDirs() Returns a list of document directories, as File.
String	getSourcePath() Returns the source path
boolean	hasDocs() Returns true if there are document directories for this entry.
boolean	hasSource() Returns true if there is source code for this repository (and therefore an API should be generated).
boolean	isUseDefaultDependencies() Returns true if no dependencies have been set.
void	setUseDefaultDependencies(boolean value) Will have this repository use the default internal dependency list.

Methods inherited from class org.erowid.masterdoc.Repository

getGeneralUrl, getLongDescription, getName, getPathFromFileList, getShortDescription, hasGeneralUrl, setGeneralUrl, setLongDescription, setName, setShortDescription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InternalRepository

public InternalRepository(String name,
                          String shortDescription,
                          String longDescription,
                          String generalUrl)

Parameters:

name -

shortDescription -

longDescription -

Method Detail

hasSource

public boolean hasSource()

Returns true if there is source code for this repository (and therefore an API should be generated).

hasDocs

public boolean hasDocs()

Returns true if there are document directories for this entry.

getSourcePath

public String getSourcePath()

Returns the source path

addSourcePath

public void addSourcePath(File path)

Adds a source path

addDocDir

public void addDocDir(File path)

Adds a document directory.

getDocDirs

public LinkedList getDocDirs()

Returns a list of document directories, as File.

getDependencies

public LinkedList getDependencies()

Returns the internal dependencies for this repository.

setUseDefaultDependencies

public void setUseDefaultDependencies(boolean value)

Will have this repository use the default internal dependency list.

addDependency

public void addDependency(String name)

Adds an internal dependency. Also sets to not use default internal dependencies.

isUseDefaultDependencies

public boolean isUseDefaultDependencies()

Returns true if no dependencies have been set.