com.codemesh.terp.eval.executors
Class FileContentsGetter

java.lang.Object
  com.codemesh.terp.api.Executor.AbstractExecutor<Rvalue>
      com.codemesh.terp.eval.executors.FileContentsGetter

All Implemented Interfaces:

Executor<Rvalue>

public class FileContentsGetter
extends Executor.AbstractExecutor<Rvalue>

An executor for dealing with file contents in byte or text form.

Nested Class Summary

static class	FileContentsGetter.RContents
static class	FileContentsGetter.RLines
static class	FileContentsGetter.RText

Nested classes/interfaces inherited from interface com.codemesh.terp.api.Executor

Executor.AbstractExecutor<T>, Executor.ForMethod

Field Summary

static java.lang.String	BYTES
static java.lang.String	LINES
static java.lang.String	TEXT

Constructor Summary

FileContentsGetter(java.lang.String op)

Method Summary

Rvalue	execute(java.util.List<java.lang.Object> args, TerpEvaluator eval, TerpContext ctx) Performs the executor's action on the given arguments in the given context.
static byte[]	getContents(java.io.File file)
static byte[]	getContents(java.io.FileInputStream is)
static java.lang.String[]	getLines(java.io.File file)
static java.lang.String[]	getLines(java.io.File file, java.lang.String encoding)
static java.lang.String	getText(java.io.File file)
static java.lang.String	getText(java.io.FileInputStream fis)
static java.lang.String	getText(java.io.FileInputStream fis, java.lang.String encoding)
static java.lang.String	getText(java.io.File file, java.lang.String encoding)
boolean	matches(java.util.List<java.lang.Object> args) Returns true if the executor applies to the given arguments.

Methods inherited from class com.codemesh.terp.api.Executor.AbstractExecutor

execute

Methods inherited from class java.lang.Object

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

Field Detail

BYTES

public static final java.lang.String BYTES

See Also:

Constant Field Values

LINES

public static final java.lang.String LINES

See Also:

Constant Field Values

TEXT

public static final java.lang.String TEXT

See Also:

Constant Field Values

Constructor Detail

FileContentsGetter

public FileContentsGetter(java.lang.String op)

Method Detail

matches

public boolean matches(java.util.List<java.lang.Object> args)

Description copied from interface: Executor

Returns true if the executor applies to the given arguments. Typically, your custom executor will implement this method to check for the proper number of arguments and the proper argument types.

Parameters:

args - the arguments passed to the executor.

Returns:

true if the executor knows how to handle the given arguments, false otherwise.

execute

public Rvalue execute(java.util.List<java.lang.Object> args,
                      TerpEvaluator eval,
                      TerpContext ctx)

Description copied from interface: Executor

Performs the executor's action on the given arguments in the given context. Typically, your custom executor will implement this method to provide its core functionality.

Parameters:

args - the arguments.

eval - the evaluator to use. Can frequently be null.

ctx - the context in which the execution occurs. Can frequently be null.

Returns:

the execution result.

getContents

public static byte[] getContents(java.io.File file)
                          throws java.io.IOException

Throws:

java.io.IOException

getContents

public static byte[] getContents(java.io.FileInputStream is)
                          throws java.io.IOException

Throws:

java.io.IOException

getText

public static java.lang.String getText(java.io.File file)
                                throws java.io.IOException

Throws:

java.io.IOException

getText

public static java.lang.String getText(java.io.File file,
                                       java.lang.String encoding)
                                throws java.io.IOException

Throws:

java.io.IOException

getText

public static java.lang.String getText(java.io.FileInputStream fis)
                                throws java.io.IOException

Throws:

java.io.IOException

getText

public static java.lang.String getText(java.io.FileInputStream fis,
                                       java.lang.String encoding)
                                throws java.io.IOException

Throws:

java.io.IOException

getLines

public static java.lang.String[] getLines(java.io.File file)
                                   throws java.io.IOException

Throws:

java.io.IOException

getLines

public static java.lang.String[] getLines(java.io.File file,
                                          java.lang.String encoding)
                                   throws java.io.IOException

Throws:

java.io.IOException