Schnittstelle StreamSourceFormat
- Alle bekannten Implementierungsklassen:
PropertiesSourceFormat
,XmlSourceFormat
public interface StreamSourceFormat
A format for a stream-based source, e.g. properties or XML.
$Id: StreamSourceFormat.java 1839288 2018-08-27 09:48:33Z tv $
-
Methodenübersicht
Modifizierer und TypMethodeBeschreibungGets the filename extension this source type typically has.getKey()
Returns an unique key for the source format.parse
(InputStream inputStream, ControllerState controllerState) Parses a source file and returns its root element.
-
Methodendetails
-
getKey
String getKey()Returns an unique key for the source format.- Gibt zurück:
- an unique key for the source format, not null.
-
getFilenameExtension
String getFilenameExtension()Gets the filename extension this source type typically has.- Gibt zurück:
- 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.- Parameter:
inputStream
- the stream to read the source file from, not null.controllerState
- the controller state, not null.- Gibt zurück:
- the root element of the source, containing the rest of the source as linked elements.
- Löst aus:
SourceException
- if reading or parsing the source fails.NullPointerException
- ifinputStream
is null.
-