public final class TopicSet extends DocumentSetBase
clientProperties
ACTION_REDRAW, ACTION_TRANSCLUDE, ACTION_VALIDATE
DOCUMENT_SET_PROPERTY
Modifier and Type | Method and Description |
---|---|
URL[] |
getMemberURLs()
Convenience method: same as
DocumentSet.getMemberURLSet() but
returns an array. |
Set<URL> |
getMemberURLSet()
Returns the URLs of the members of this document set.
|
URL |
getSpecificationURL()
Returns the URL of the XML file specifying this document set
(example: the DITA topmost map).
|
boolean |
update(Console console)
Update this document set.
|
getActionsAfterUpdate, getClientProperty, setClientProperty
public URL getSpecificationURL()
DocumentSet
May return null
, in which case the specification
of this document set does not come from an XML file.
public Set<URL> getMemberURLSet()
DocumentSet
May return an empty set (not null
).
In the case of a modular document, the master document (example: DocBook modular book) is at the same time a member and the specification of this document set.
Important: the returned set must not be modified by client code.
public URL[] getMemberURLs()
DocumentSet
DocumentSet.getMemberURLSet()
but
returns an array.public boolean update(Console console)
DocumentSet
important: if the document set cannot be updated, do not corrupt it, keep it in its previous state. (Temporary errors may happen while the master document is being modified by the user.)
console
- console used to report progress, warnings and errorstrue
if successfully updated;
false
otherwise