eu.lindenbaum.maven.erlang
Class DialyzerScript

java.lang.Object
  eu.lindenbaum.maven.erlang.DialyzerScript

All Implemented Interfaces:

Script<String[]>

public final class DialyzerScript
extends Object

A Script that can be used to dialyze erlang files.

Author:

Tobias Schlager

Field Summary

protected String

script

Fields inherited from interface eu.lindenbaum.maven.erlang.Script

NL

Constructor Summary

DialyzerScript(List<File> directories, List<File> includes, String options)
Creates a dialyzer script for a List of erlang source files, includes.

Method Summary

String	get() Returns an evaluateable String containing the erlang script of the implementing class.
String[]	handle(com.ericsson.otp.erlang.OtpErlangObject result) Converts the result of the Script execution into a list of dialyzer warning strings.

Methods inherited from class java.lang.Object

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

Field Detail

script

protected final String script

Constructor Detail

DialyzerScript

public DialyzerScript(List<File> directories,
                      List<File> includes,
                      String options)
               throws org.apache.maven.plugin.MojoExecutionException

Creates a dialyzer script for a List of erlang source files, includes.

Parameters:

directories - a list of source directories to dialyze (from source)

includes - a list of include files

options - a list of dialyzer options according to the erlang docs

Throws:

org.apache.maven.plugin.MojoExecutionException

See Also:

http://www.erlang.org/doc/man/dialyzer.html

Method Detail

get

public String get()

Returns an evaluateable String containing the erlang script of the implementing class.

Returns:

An erlang script that can be evaluated.

handle

public String[] handle(com.ericsson.otp.erlang.OtpErlangObject result)

Converts the result of the Script execution into a list of dialyzer warning strings.

Parameters:

result - The return term of the Script execution.

Returns:

A list of warning strings issued by the erlang dialyzer.