Package uk.ac.starlink.ttools.build
Class SchemeDoc
java.lang.Object
uk.ac.starlink.ttools.build.SchemeDoc
Writes a section of XML text documenting the details of TableSchemes
available within the STILTS application.
- Since:
- 4 Sep 2020
- Author:
- Mark Taylor
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetXmlDoc
(uk.ac.starlink.table.TableScheme scheme) Returns a string containing an XML subsubsect element decribing a given TableScheme.static void
Writes a sequence of XML subsubsect elements to standard output, documenting the TableSchemes available by default from STILTS.
-
Constructor Details
-
SchemeDoc
public SchemeDoc(boolean requiresDoc) Constructor.- Parameters:
requiresDoc
- if true, an error is generated for TableSchemes that do not implement the interface uk.ac.starlink.table.Documented
-
-
Method Details
-
getXmlDoc
Returns a string containing an XML subsubsect element decribing a given TableScheme.- Parameters:
scheme
- table scheme, preferably implementing Documented- Returns:
- XML text
- Throws:
IOException
-
main
Writes a sequence of XML subsubsect elements to standard output, documenting the TableSchemes available by default from STILTS.- Throws:
IOException
-