uk.ac.starlink.ttools
Class DocUtils

java.lang.Object
  extended by uk.ac.starlink.ttools.DocUtils

public class DocUtils
extends Object

Utilities used for automatically-generated documentation.

Since:
27 Sep 2006
Author:
Mark Taylor

Method Summary
static String filterRef(BasicFilter filter)
          Provides a snippet of XML which references a processing filter.
static String join(String[] lines)
          Concatenates an array of strings, appending a carriage return to each one.
static String listInfos(ValueInfo[] infos)
          Returns an string listing the supplied array of metadata objects.
static String modeRef(String name)
          Provides a snippet of XML which references a named ProcessingMode.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

join

public static String join(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 String filterRef(BasicFilter filter)
Provides a snippet of XML which references a processing filter.

Parameters:
filter - processing filter
Returns:
filter reference

modeRef

public static String modeRef(String name)
Provides a snippet of XML which references a named ProcessingMode.

Parameters:
name - mode name
Returns:
mode reference

listInfos

public static String listInfos(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


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.