org.apache.torque.generator.source.stream
Interface StreamSourceFormat

All Known Implementing Classes:

PropertiesSourceFormat, XmlSourceFormat

public interface StreamSourceFormat

A format for a stream-based source, e.g. properties or XML. $Id: StreamSourceFormat.java 1331190 2012-04-27 02:41:35Z tfischer $

Method Summary

String	getFilenameExtension() Gets the filename extension this source type typically has.
String	getKey() Returns an unique key for the source format.
SourceElement	parse(InputStream inputStream, ControllerState controllerState) Parses a source file and returns its root element.

Method Detail

getKey

String getKey()

Returns an unique key for the source format.

Returns:

an unique key for the source format, not null.

getFilenameExtension

String getFilenameExtension()

Gets the filename extension this source type typically has.

Returns:

the filename extension without leading dot, or null if no typical extension exists.

parse

SourceElement parse(InputStream inputStream,
                    ControllerState controllerState)
                    throws SourceException

Parses a source file and returns its root element.

Parameters:

inputStream - the stream to read the source file from, not null.

ControllerState - the controller state, not null.

Returns:

the root element of the source, containing the rest of the source as linked elements.

Throws:

SourceException - if reading or parsing the source fails.

NullPointerException - if inputStream is null.