Package freemarker.debug
Interface DebugModel
-
- All Superinterfaces:
java.rmi.Remote
- All Known Subinterfaces:
DebuggedEnvironment
public interface DebugModel extends java.rmi.RemoteRepresents the debugger-side mirror of a TemplateModel object, a Template object, or a Configuration object. The Environment objects are also represented by instances of this model, although not directly but through a separate subinterfaceDebuggedEnvironment. The interface is a union of almost all of FreeMarker template models with identical method signatures. For purposes of optimizing network traffic there are bulk retrieval methods for sequences and hashes, as well as agetModelTypes()method that returns a bit mask of various TYPE_xxx constants flagging which template models are implemented by the mirrored object.
-
-
Field Summary
Fields Modifier and Type Field Description static intTYPE_BOOLEANstatic intTYPE_COLLECTIONstatic intTYPE_CONFIGURATIONstatic intTYPE_DATEstatic intTYPE_ENVIRONMENTstatic intTYPE_HASHstatic intTYPE_HASH_EXstatic intTYPE_METHODstatic intTYPE_METHOD_EXstatic intTYPE_NUMBERstatic intTYPE_SCALARstatic intTYPE_SEQUENCEstatic intTYPE_TEMPLATEstatic intTYPE_TRANSFORM
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DebugModelget(int index)DebugModel[]get(int fromIndex, int toIndex)DebugModelget(java.lang.String key)DebugModel[]get(java.lang.String[] keys)booleangetAsBoolean()java.util.DategetAsDate()java.lang.NumbergetAsNumber()java.lang.StringgetAsString()DebugModel[]getCollection()intgetDateType()intgetModelTypes()java.lang.String[]keys()intsize()
-
-
-
Field Detail
-
TYPE_SCALAR
static final int TYPE_SCALAR
- See Also:
- Constant Field Values
-
TYPE_NUMBER
static final int TYPE_NUMBER
- See Also:
- Constant Field Values
-
TYPE_DATE
static final int TYPE_DATE
- See Also:
- Constant Field Values
-
TYPE_BOOLEAN
static final int TYPE_BOOLEAN
- See Also:
- Constant Field Values
-
TYPE_SEQUENCE
static final int TYPE_SEQUENCE
- See Also:
- Constant Field Values
-
TYPE_COLLECTION
static final int TYPE_COLLECTION
- See Also:
- Constant Field Values
-
TYPE_HASH
static final int TYPE_HASH
- See Also:
- Constant Field Values
-
TYPE_HASH_EX
static final int TYPE_HASH_EX
- See Also:
- Constant Field Values
-
TYPE_METHOD
static final int TYPE_METHOD
- See Also:
- Constant Field Values
-
TYPE_METHOD_EX
static final int TYPE_METHOD_EX
- See Also:
- Constant Field Values
-
TYPE_TRANSFORM
static final int TYPE_TRANSFORM
- See Also:
- Constant Field Values
-
TYPE_ENVIRONMENT
static final int TYPE_ENVIRONMENT
- See Also:
- Constant Field Values
-
TYPE_TEMPLATE
static final int TYPE_TEMPLATE
- See Also:
- Constant Field Values
-
TYPE_CONFIGURATION
static final int TYPE_CONFIGURATION
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAsString
java.lang.String getAsString() throws TemplateModelException, java.rmi.RemoteException- Throws:
TemplateModelExceptionjava.rmi.RemoteException
-
getAsNumber
java.lang.Number getAsNumber() throws TemplateModelException, java.rmi.RemoteException- Throws:
TemplateModelExceptionjava.rmi.RemoteException
-
getAsBoolean
boolean getAsBoolean() throws TemplateModelException, java.rmi.RemoteException- Throws:
TemplateModelExceptionjava.rmi.RemoteException
-
getAsDate
java.util.Date getAsDate() throws TemplateModelException, java.rmi.RemoteException- Throws:
TemplateModelExceptionjava.rmi.RemoteException
-
getDateType
int getDateType() throws TemplateModelException, java.rmi.RemoteException- Throws:
TemplateModelExceptionjava.rmi.RemoteException
-
size
int size() throws TemplateModelException, java.rmi.RemoteException
- Throws:
TemplateModelExceptionjava.rmi.RemoteException
-
get
DebugModel get(int index) throws TemplateModelException, java.rmi.RemoteException
- Throws:
TemplateModelExceptionjava.rmi.RemoteException
-
get
DebugModel[] get(int fromIndex, int toIndex) throws TemplateModelException, java.rmi.RemoteException
- Throws:
TemplateModelExceptionjava.rmi.RemoteException
-
get
DebugModel get(java.lang.String key) throws TemplateModelException, java.rmi.RemoteException
- Throws:
TemplateModelExceptionjava.rmi.RemoteException
-
get
DebugModel[] get(java.lang.String[] keys) throws TemplateModelException, java.rmi.RemoteException
- Throws:
TemplateModelExceptionjava.rmi.RemoteException
-
getCollection
DebugModel[] getCollection() throws TemplateModelException, java.rmi.RemoteException
- Throws:
TemplateModelExceptionjava.rmi.RemoteException
-
keys
java.lang.String[] keys() throws TemplateModelException, java.rmi.RemoteException- Throws:
TemplateModelExceptionjava.rmi.RemoteException
-
getModelTypes
int getModelTypes() throws java.rmi.RemoteException- Throws:
java.rmi.RemoteException
-
-