avcl

Class Converter

java.lang.Object

avcl.Converter

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

JaxbConverter, XsltConverter

public abstract class Converter
extends Object
implements Runnable

Filename : Converter.java Description : Abstract class to provide a conversion utility for transforming AVCL files into other formats. The input can be specified as an AVCL file name, a Java File object referencing an AVCL file, an Input Stream from an AVCL file, or an unmarshalled jaxb AVCL object

Since:

: 17 May 2004 Program : AUV Workbench Platform : Windows 2000/Windows XP

Version:

$Id: Converter.java 8086 2012-07-16 23:46:35Z tnorbraten $

Author:

: Duane Davis

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoStreamClose Set to true if the output stream automatically closes after the conversion
protected OutputStream	outStream Stream to which the AVCL will be written

Constructor Summary

Constructors

Constructor and Description
Converter(File outFile) Creates the input streams and assigns the local variables assigning conversion output sources
Converter(OutputStream outStream) Creates a converter and sets the output stream for the result, but nothing else
Converter(String outFile) Creates the input streams and assigns the local variables from which

Method Summary

Methods

Modifier and Type	Method and Description
void	closeStream() Manually closes the output stream of the converter Separated from the run method to allow the stream to remain open if required for multiple conversions over the same pipe (e.g., communications or high level vehicle control)
void	run()
abstract boolean	runConversion() Executes the actual conversion and writes the results to the designated output file
void	setAutoStreamClose(boolean value) Sets automatic output stream closing to true or false

Methods inherited from class java.lang.Object

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

Field Detail

outStream

protected OutputStream outStream

Stream to which the AVCL will be written

autoStreamClose

protected boolean autoStreamClose

Set to true if the output stream automatically closes after the conversion

Constructor Detail

Converter

public Converter(String outFile)
          throws FileNotFoundException

Creates the input streams and assigns the local variables from which

Parameters:

outFile - destination

Throws:

FileNotFoundException

Converter

public Converter(File outFile)
          throws FileNotFoundException

Creates the input streams and assigns the local variables assigning conversion output sources

Parameters:

outFile - destination

Throws:

FileNotFoundException

Converter

public Converter(OutputStream outStream)

Creates a converter and sets the output stream for the result, but nothing else

Parameters:

outStream - destination stream for the conversion results

Method Detail

runConversion

public abstract boolean runConversion()

Executes the actual conversion and writes the results to the designated output file

Returns:

true if conversion completes correctly

setAutoStreamClose

public void setAutoStreamClose(boolean value)

Sets automatic output stream closing to true or false

Parameters:

value - boolean value of the desired auto-stream close behavior

closeStream

public void closeStream()

Manually closes the output stream of the converter Separated from the run method to allow the stream to remain open if required for multiple conversions over the same pipe (e.g., communications or high level vehicle control)

run

public void run()

Specified by:

run in interface Runnable