com.codemesh.terp.eval.converters
Class ToJavadoc

java.lang.Object
  com.codemesh.terp.eval.converters.ToJavadoc

All Implemented Interfaces:

Converter<JavadocExecutor>

public class ToJavadoc
extends java.lang.Object
implements Converter<JavadocExecutor>

A converter to Javadoc executors. This converter is registered with the terp runtime under the ^javadoc() alias.

Field Summary

protected static ToFile	TO_FILE
protected static ToVersion	TO_VERSION

Constructor Summary

ToJavadoc()

Method Summary

JavadocExecutor	fromFile(java.io.File java)
JavadocExecutor	fromMap(JavadocExecutor result, java.util.Map map)
JavadocExecutor	fromMap(java.util.Map map)
JavadocExecutor	fromObject(java.lang.Object obj, TerpContext ctx) Converts the given object into an object of the target type.
JavadocExecutor	fromString(java.lang.String java)
JavadocExecutor	fromVersion(Version vers)

Methods inherited from class java.lang.Object

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

Field Detail

TO_VERSION

protected static final ToVersion TO_VERSION

TO_FILE

protected static final ToFile TO_FILE

Constructor Detail

ToJavadoc

public ToJavadoc()

Method Detail

fromObject

public JavadocExecutor fromObject(java.lang.Object obj,
                                  TerpContext ctx)

Converts the given object into an object of the target type. Conversions can be implemented in any way that makes sense. Normally, converters will return null for null, but some converters may choose to interpret null as an indicator to return a default-initialized target object. An example of this type of conversion is the ShellExecutor. null simply indicates that no preference overrides of any kind have been provided.

Specified by:

fromObject in interface Converter<JavadocExecutor>

Parameters:

obj - the source object.

ctx - the context in which the conversion takes place.

Returns:

an instance of the target type or null.

fromString

public JavadocExecutor fromString(java.lang.String java)

fromFile

public JavadocExecutor fromFile(java.io.File java)

fromVersion

public JavadocExecutor fromVersion(Version vers)

fromMap

public JavadocExecutor fromMap(java.util.Map map)

fromMap

public JavadocExecutor fromMap(JavadocExecutor result,
                               java.util.Map map)