|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.build.LayerTypeDoc
public class LayerTypeDoc
Writes XML text documenting known plot2 LayerTypes.
Output is to standard output.
This class is designed to be used from its main
method.
Constructor Summary | |
---|---|
LayerTypeDoc(boolean basicXml)
Constructor. |
Method Summary | |
---|---|
static Map<String,LayerType> |
getLayerTypes(TypedPlot2Task[] tasks)
Returns a map (keyed by name) of all the LayerTypes used by a given list of tasks. |
static TypedPlot2Task[] |
getPlot2Tasks()
Returns a list of all the TypedPlot2Tasks known to Stilts. |
String |
getXmlDoc(LayerType layerType)
Returns an XML element giving full user documentation for a given layer type. |
static String |
layerTypeRef(LayerType ltype)
Returns XML text that can be used to reference a LayerType description in the user document. |
static void |
main(String[] args)
Main method. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LayerTypeDoc(boolean basicXml)
basicXml
- avoid XML constructs that won't show up in text outputMethod Detail |
---|
public String getXmlDoc(LayerType layerType)
layerType
- layer type
public static TypedPlot2Task[] getPlot2Tasks() throws LoadException
LoadException
public static Map<String,LayerType> getLayerTypes(TypedPlot2Task[] tasks)
known
- task list
public static String layerTypeRef(LayerType ltype)
ltype
- layer type
public static void main(String[] args) throws LoadException
-help
.
LoadException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |