xbn.jdlcode
Class PackageType

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.jdlcode.PackageType

All Implemented Interfaces:

Named

public class PackageType

extends XBNObject

implements Named

Defines a package type whose classes are liked to, from your JavaDoc html files. Manage a set of PackageTypes with a PTArray.

Source code: PackageType.java.

All package types are defined above the "~" line, in the doclet class map. See UtilJDLCode.getJDCAFromFLR and getPackageTypeFromLine.

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

PackageType(String s_prefix, String s_externalUrl)
Create a PackageType.

Method Summary

String	getExternalUrl() Get the prefix for this PackageType.
String	getName() A synonym for getPrefix().
String	getPrefix() Get the prefix for this PackageType.
boolean	isExternal() Is this PackageType external?
boolean	isLocal() Is this PackageType local?
String	toString() Get some information about this PackageType.

Methods inherited from class xbn.XBNObject

getXMsgPrefix, sop, sopl, sopl, throwAX, throwAXIfBadStr, throwAXIfNull, throwAXSpoof

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageType

public PackageType(String s_prefix,
                   String s_externalUrl)

Create a PackageType.

Parameters:

s_prefix - The prefix of a package type. For example, the package type prefix for

• java.lang.Object
• java.io.File
• java.sql.Connection

is java

The package type prefix for

• xbn.XBNObject
• xbn.array.VWObject
• xbn.util.UtilString

To do: Package prefixes should be allowed to have a dot in them. This will prevent conflicts when using multiple packages starting with "com.".

is xbn

s_externalUrl - The url to the external package's root JavaDoc directory, including the final slash. Inside of this url directory must exist a folder named (the value of) s_prefix. When null, this package type is local, meaning the JavaDoc files for these packages are generated by you.

Method Detail

getPrefix

public String getPrefix()

Get the prefix for this PackageType.

Returns:

s_prefix, exactly as provided to the constructor.

isExternal

public boolean isExternal()

Is this PackageType external?

Returns:

(getExternalUrl() != null)

isLocal

public boolean isLocal()

Is this PackageType local?

Returns:

!isExternal()

getExternalUrl

public String getExternalUrl()

Get the prefix for this PackageType.

Returns:

s_externalUrl, exactly as provided to the constructor.

getName

public String getName()

A synonym for getPrefix(). See getPrefix.

Specified by:

getName in interface Named

toString

public String toString()

Get some information about this PackageType.

Overrides:

toString in class Object