ccs.cpc.impl
Class XSPFWriter

java.lang.Object
  ccs.cpc.impl.XSPFWriter

public class XSPFWriter
extends java.lang.Object

Writes a Checkpoint result set as an XSPF file. It's far easier to do this from scratch than to attempt to use an XSPFFile - the write capability of that is intended to situations where you're massaging an existing XSPF file rather than creating a new one. The class comes in two parts. Firstly there's a static method which actually does the write; this arose for historical reasons and is retained in case it may prove useful in future. Secondly there's a instantiable aspect which walks the user through the save process (culminating in a call to the static writer, if it gets that far).

Constructor Summary

XSPFWriter(CpcImpl cpc, BrowserLogic bl)

Method Summary

(package private) void	run() The interactive entry point.
static void	write(java.io.OutputStream os, java.lang.String title, VFile[] contents, int npretrim, java.lang.String prefix) Perform the raw write.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XSPFWriter

XSPFWriter(CpcImpl cpc,
           BrowserLogic bl)

Method Detail

run

void run()
   throws java.io.IOException

The interactive entry point.

Throws:

java.io.IOException

write

public static void write(java.io.OutputStream os,
                         java.lang.String title,
                         VFile[] contents,
                         int npretrim,
                         java.lang.String prefix)
                  throws java.io.IOException

Perform the raw write. This interface is separate to allow for future expansion.

Parameters:

os - The stream to write to.

title - The title of the result set.

contents - The results to write.

npretrim - The number of characters to trim from the front of the VFileUrl path. Used for restricted-caps saves.

prefix - The prefix to add to the front of the trimmed url path. Used for restricted-caps saves.

Throws:

java.io.IOException