XdcPackage (XDC - the XML Documentation Generator)

Overview

Package

Class

Tree

Deprecated

Index

Help

XDC - v. 0.6.1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.sf.xdc.processing
Class XdcPackage

java.lang.Object
  net.sf.xdc.processing.XdcPackage

public class XdcPackage
extends java.lang.Object

This class represents a "package" of sources. This is essentially a directory containing one or more XML files to be processed by XDC.

Since:: 0.5
Version:: 0.5
Author:: Jens Voß

Constructor Summary
`XdcPackage(java.lang.String name)` Public constructor.

Method Summary
`void`	`addSource(XdcSource xdcSource)` This method is used to register an `XdcSource` with this `XdcPackage`.
`java.lang.String`	`getName()` Getter method for this `XdcPackage`'s name.
`java.lang.String`	`getSummaryText()` This method retrieves the relevant package summary file text.
`XdcSource`	`getXdcSource(java.lang.String sourceName)` This method retrieves a particular `XdcSource` object from this `XdcPackage` by its (non-qualified) name.
`XdcSource[]`	`getXdcSources()` This method retrieves all registered `XdcSource` objects.
`void`	`removeSource(XdcSource xdcSource)` This method is used to unregister an `XdcSource` from this `XdcPackage`.

Methods inherited from class java.lang.Object

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

Constructor Detail

XdcPackage

public XdcPackage(java.lang.String name)

Public constructor.
Parameters:: name - The name of the package. This amounts to the last part of the source directory path.

Method Detail

getName

public java.lang.String getName()

Getter method for this XdcPackage's name.

Returns:: The name of this XdcPackage

addSource

public void addSource(XdcSource xdcSource)

This method is used to register an XdcSource with this XdcPackage.

Parameters:: xdcSource - An XdcSource object to be registered with this XdcPackage

removeSource

public void removeSource(XdcSource xdcSource)

This method is used to unregister an XdcSource from this XdcPackage.

Parameters:: xdcSource - An XdcSource object to be unregistered from this XdcPackage

getXdcSources

public XdcSource[] getXdcSources()

This method retrieves all registered XdcSource objects.

Returns:: An array of all XdcSource objects registered with this XdcPackage

getXdcSource

public XdcSource getXdcSource(java.lang.String sourceName)

This method retrieves a particular XdcSource object from this XdcPackage by its (non-qualified) name.

Parameters:: sourceName - The name of the XdcSource to be retrieved
Returns:: The XdcSource of this XdcPackage with the name sourceName

getSummaryText

public java.lang.String getSummaryText()

This method retrieves the relevant package summary file text. This text is the portion between the opening and the closing <body> tag of a file named xdc-package.html which is placed in this XdcPackage's source directory.

Returns:: The relevant text from the package summary file. Note that this text is returned "raw", i.e. with XDC tags not yet resolved.