Package freemarker.ext.jython
Class JythonModel
java.lang.Object
freemarker.ext.jython.JythonModel
- All Implemented Interfaces:
WrapperTemplateModel,AdapterTemplateModel,TemplateBooleanModel,TemplateHashModel,TemplateMethodModel,TemplateMethodModelEx,TemplateModel,TemplateScalarModel
- Direct Known Subclasses:
JythonHashModel,JythonNumberModel,JythonSequenceModel
public class JythonModel
extends Object
implements TemplateBooleanModel, TemplateScalarModel, TemplateHashModel, TemplateMethodModelEx, AdapterTemplateModel, WrapperTemplateModel
Generic model for arbitrary Jython objects.
-
Field Summary
FieldsFields inherited from interface freemarker.template.TemplateBooleanModel
FALSE, TRUEFields inherited from interface freemarker.template.TemplateModel
NOTHINGFields inherited from interface freemarker.template.TemplateScalarModel
EMPTY_STRING -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionExecutes the method call.CallsPyObject.__findattr__(java.lang.String), then if it returns null callsPyObject.__finditem__(java.lang.String).getAdaptedObject(Class hint)Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.booleanReturns the value ofPyObject.__nonzero__().Returns the value ofObject.toString().Retrieves the original object wrapped by this model.booleanisEmpty()ReturnsPyObject.__len__()== 0.
-
Field Details
-
object
protected final org.python.core.PyObject object -
wrapper
-
-
Constructor Details
-
JythonModel
-
-
Method Details
-
getAsBoolean
Returns the value ofPyObject.__nonzero__().- Specified by:
getAsBooleanin interfaceTemplateBooleanModel- Returns:
- whether to interpret this object as true or false in a boolean context
- Throws:
TemplateModelException
-
getAsString
Returns the value ofObject.toString().- Specified by:
getAsStringin interfaceTemplateScalarModel- Throws:
TemplateModelException
-
get
CallsPyObject.__findattr__(java.lang.String), then if it returns null callsPyObject.__finditem__(java.lang.String). IfJythonWrapper.setAttributesShadowItems(boolean)was called withfalse, the order of calls is reversed (that is, item lookup takes precedence over attribute lookup).- Specified by:
getin interfaceTemplateHashModel- Parameters:
key- The name by which theTemplateModelis identified in the template.- Returns:
- The
TemplateModelreferred to by the key, ornullif not found. - Throws:
TemplateModelException
-
isEmpty
ReturnsPyObject.__len__()== 0.- Specified by:
isEmptyin interfaceTemplateHashModel- Throws:
TemplateModelException
-
exec
Description copied from interface:TemplateMethodModelExExecutes the method call.- Specified by:
execin interfaceTemplateMethodModel- Specified by:
execin interfaceTemplateMethodModelEx- Parameters:
arguments- aListofTemplateModel-s, containing the arguments passed to the method. If the implementation absolutely wants to operate on POJOs, it can use the static utility methods in theDeepUnwrapclass to easily obtain them. However, unwrapping is not always possible (or not perfectly), and isn't always efficient, so it's recommended to use the originalTemplateModelvalue as much as possible.- Returns:
- the return value of the method, or
null. If the returned value does not implementTemplateModel, it will be automatically wrapped using theenvironment's object wrapper. - Throws:
TemplateModelException- See Also:
TemplateMethodModel.exec(List)
-
getAdaptedObject
Description copied from interface:AdapterTemplateModelRetrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.- Specified by:
getAdaptedObjectin interfaceAdapterTemplateModel- Parameters:
hint- the desired class of the returned value. An implementation should make reasonable effort to retrieve an object of the requested class, but if that is impossible, it must at least return the underlying object as-is. As a minimal requirement, an implementation must always return the exact underlying object whenhint.isInstance(underlyingObject)holds. When called withjava.lang.Object.class, it should return a generic Java object (i.e. if the model is wrapping a scripting language object that is further wrapping a Java object, the deepest underlying Java object should be returned).- Returns:
- the underlying object, or its value accommodated for the hint class.
-
getWrappedObject
Description copied from interface:WrapperTemplateModelRetrieves the original object wrapped by this model.- Specified by:
getWrappedObjectin interfaceWrapperTemplateModel
-