Package uk.ac.starlink.ttools
Class DocUtils
- java.lang.Object
-
- uk.ac.starlink.ttools.DocUtils
-
public class DocUtils extends java.lang.Object
Utilities used for automatically-generated documentation.- Since:
- 27 Sep 2006
- Author:
- Mark Taylor
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.lang.String
filterRef(BasicFilter filter)
Provides a snippet of XML which references a processing filter.static java.lang.String
join(java.lang.String[] lines)
Concatenates an array of strings, appending a carriage return to each one.static java.lang.String
listInfos(uk.ac.starlink.table.ValueInfo[] infos)
Returns an string listing the supplied array of metadata objects.static java.lang.String
modeRef(java.lang.String name)
Provides a snippet of XML which references a namedProcessingMode
.
-
-
-
Method Detail
-
join
public static java.lang.String join(java.lang.String[] lines)
Concatenates an array of strings, appending a carriage return to each one.- Parameters:
lines
- array of input strings- Returns:
- one long output string
-
filterRef
public static java.lang.String filterRef(BasicFilter filter)
Provides a snippet of XML which references a processing filter.- Parameters:
filter
- processing filter- Returns:
- filter reference
-
modeRef
public static java.lang.String modeRef(java.lang.String name)
Provides a snippet of XML which references a namedProcessingMode
.- Parameters:
name
- mode name- Returns:
- mode reference
-
listInfos
public static java.lang.String listInfos(uk.ac.starlink.table.ValueInfo[] infos)
Returns an string listing the supplied array of metadata objects. The returned string should be suitable for inserting into XML text.- Parameters:
infos
- array of infos- Returns:
- string listing
infos
by name
-
-