org.openmrs.module

Class ModuleFileParser

java.lang.Object

org.openmrs.module.ModuleFileParser

public class ModuleFileParser
extends Object

This class will parse an OpenMRS module, specifically its config.xml file into a Module object.

Typical usage is:

1. Create a ModuleFileParser with ModuleFileParser(MessageSourceService).
2. Parse the module by passing the file to parse(File).

Note that the parser does not validate the config.xml file against the document type definition's (DTD).

Constructor Summary

Constructors

Constructor and Description
ModuleFileParser(File moduleFile) Deprecated. since 2.2.0 use ModuleFileParser(MessageSourceService)
ModuleFileParser(InputStream inputStream) Deprecated. since 2.2.0 use ModuleFileParser(MessageSourceService)
ModuleFileParser(MessageSourceService messageSourceService) Creates a ModuleFileParser.

Method Summary

Modifier and Type	Method and Description
Module	parse() Deprecated. since 2.2.0 use parse(File)
Module	parse(File moduleFile) Get the module from an OpenMRS module file.
Module	parse(InputStream inputStream) Parses the given InputStream of an OpenMRS module into a Module.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleFileParser

public ModuleFileParser(MessageSourceService messageSourceService)

Creates a ModuleFileParser.

Parameters:

messageSourceService - the message source used for error messages

Since:

2.2.0

ModuleFileParser

@Deprecated
public ModuleFileParser(File moduleFile)

Deprecated. since 2.2.0 use ModuleFileParser(MessageSourceService)

Constructor

Parameters:

moduleFile - the module (jar)file that will be parsed

ModuleFileParser

@Deprecated
public ModuleFileParser(InputStream inputStream)

Deprecated. since 2.2.0 use ModuleFileParser(MessageSourceService)

Convenience constructor to parse the given inputStream file into an omod.
This copies the stream into a temporary file just so things can be parsed.

Parameters:

inputStream - the inputStream pointing to an omod file

Method Detail

parse

public Module parse(InputStream inputStream)

Parses the given InputStream of an OpenMRS module into a Module. This copies the stream into a temporary file and close given InputStream.

Parameters:

inputStream - the inputStream pointing to an omod file

Since:

2.2.0

parse

@Deprecated
public Module parse()
                         throws ModuleException

Deprecated. since 2.2.0 use parse(File)

Get the module. If you use this method only do so together with ModuleFileParser(File) or ModuleFileParser(InputStream). Best use ModuleFileParser(MessageSourceService) and parse(File) since this method is deprecated.

Returns:

new module object

Throws:

ModuleException

parse

public Module parse(File moduleFile)

Get the module from an OpenMRS module file.

Parameters:

moduleFile - the module file to be parsed

Returns:

new module object

Since:

2.2.0