001/**
002 *
003 * Copyright (c) 2014, the Railo Company Ltd. All rights reserved.
004 *
005 * This library is free software; you can redistribute it and/or
006 * modify it under the terms of the GNU Lesser General Public
007 * License as published by the Free Software Foundation; either 
008 * version 2.1 of the License, or (at your option) any later version.
009 * 
010 * This library is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013 * Lesser General Public License for more details.
014 * 
015 * You should have received a copy of the GNU Lesser General Public 
016 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
017 * 
018 **/
019package lucee.runtime.interpreter.ref;
020
021import lucee.runtime.PageContext;
022import lucee.runtime.exp.PageException;
023
024/**
025 * Define a Reference to a Object
026 */
027public interface Ref {
028        
029    /**
030     * return the value for that the reference is for
031     * @return value to reference
032     * @throws PageException
033     */
034    public Object touchValue(PageContext pc) throws PageException;
035
036    /**
037     * return the value for that the reference is for
038     * @return value to reference
039     * @throws PageException
040     */
041    public Object getValue(PageContext pc) throws PageException;
042
043    /**
044     * return the value for that the reference is for
045     * @return value to reference
046     * @throws PageException
047     */
048    public Object getCollection(PageContext pc) throws PageException;
049    
050        /**
051         * return the name name of a reference
052         * @return type as string
053         */
054        public String getTypeName();
055        
056
057        public boolean eeq(PageContext pc,Ref other) throws PageException;
058}