001: /*
002: * Copyright (c) 2003 The Visigoth Software Society. All rights
003: * reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions
007: * are met:
008: *
009: * 1. Redistributions of source code must retain the above copyright
010: * notice, this list of conditions and the following disclaimer.
011: *
012: * 2. Redistributions in binary form must reproduce the above copyright
013: * notice, this list of conditions and the following disclaimer in
014: * the documentation and/or other materials provided with the
015: * distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowledgement:
019: * "This product includes software developed by the
020: * Visigoth Software Society (http://www.visigoths.org/)."
021: * Alternately, this acknowledgement may appear in the software itself,
022: * if and wherever such third-party acknowledgements normally appear.
023: *
024: * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
025: * project contributors may be used to endorse or promote products derived
026: * from this software without prior written permission. For written
027: * permission, please contact visigoths@visigoths.org.
028: *
029: * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
030: * nor may "FreeMarker" or "Visigoth" appear in their names
031: * without prior written permission of the Visigoth Software Society.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of the Visigoth Software Society. For more
049: * information on the Visigoth Software Society, please see
050: * http://www.visigoths.org/
051: */
052:
053: package freemarker.debug;
054:
055: import java.rmi.Remote;
056: import java.rmi.RemoteException;
057: import java.util.Date;
058:
059: import freemarker.template.TemplateModelException;
060:
061: /**
062: * Represents the debugger-side mirror of a TemplateModel object, a Template
063: * object, or a Configuration object. The Environment objects are also represented
064: * by instances of this model, although not directly but through a separate
065: * subinterface {@link DebuggedEnvironment}. The interface is a union of
066: * almost all of FreeMarker template models with identical method signatures.
067: * For purposes of optimizing network traffic there are bulk retrieval methods
068: * for sequences and hashes, as well as a {@link #getModelTypes()} method that
069: * returns a bit mask of various <tt>TYPE_xxx</tt> constants flagging which
070: * template models are implemented by the mirrored object.
071: *
072: * @author Attila Szegedi
073: * @version $Id: DebugModel.java,v 1.2 2003/06/08 00:58:16 herbyderby Exp $
074: */
075: public interface DebugModel extends Remote {
076: public static final int TYPE_SCALAR = 1;
077: public static final int TYPE_NUMBER = 2;
078: public static final int TYPE_DATE = 4;
079: public static final int TYPE_BOOLEAN = 8;
080: public static final int TYPE_SEQUENCE = 16;
081: public static final int TYPE_COLLECTION = 32;
082: public static final int TYPE_HASH = 64;
083: public static final int TYPE_HASH_EX = 128;
084: public static final int TYPE_METHOD = 256;
085: public static final int TYPE_METHOD_EX = 512;
086: public static final int TYPE_TRANSFORM = 1024;
087: public static final int TYPE_ENVIRONMENT = 2048;
088: public static final int TYPE_TEMPLATE = 4096;
089: public static final int TYPE_CONFIGURATION = 8192;
090:
091: public String getAsString() throws TemplateModelException,
092: RemoteException;
093:
094: public Number getAsNumber() throws TemplateModelException,
095: RemoteException;
096:
097: public boolean getAsBoolean() throws TemplateModelException,
098: RemoteException;
099:
100: public Date getAsDate() throws TemplateModelException,
101: RemoteException;
102:
103: public int getDateType() throws TemplateModelException,
104: RemoteException;
105:
106: public int size() throws TemplateModelException, RemoteException;
107:
108: public DebugModel get(int index) throws TemplateModelException,
109: RemoteException;
110:
111: public DebugModel[] get(int fromIndex, int toIndex)
112: throws TemplateModelException, RemoteException;
113:
114: public DebugModel get(String key) throws TemplateModelException,
115: RemoteException;
116:
117: public DebugModel[] get(String[] keys)
118: throws TemplateModelException, RemoteException;
119:
120: public DebugModel[] getCollection() throws TemplateModelException,
121: RemoteException;
122:
123: public String[] keys() throws TemplateModelException,
124: RemoteException;
125:
126: public int getModelTypes() throws RemoteException;
127: }
|