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;
020
021import java.io.Serializable;
022
023import lucee.commons.io.res.Resource;
024
025
026/**
027 * represent a cfml source file
028 */
029public interface SourceFile extends Serializable {
030
031    /**
032         * return file object, based on physical path and relpath
033         * @return file Object
034         */
035        public Resource getPhyscalFile();
036
037        /**
038     * @return return source path as String
039     */
040    public String getDisplayPath();
041
042        /**
043         * @return returns the full classname (package and name) matching to filename (Example: my.package.test_cfm)
044         */
045        public String getFullClassName();
046
047        /**
048         * @return returns the a classname matching to filename (Example: test_cfm)
049         */
050        public String getClassName();
051
052        /**
053         * @return returns the a package matching to file (Example: lucee.web)
054         */
055        public String getPackageName();
056
057        /**
058         * @return returns a variable string based on realpath and return it
059         */
060        public String getRealPathAsVariableString();
061
062        /**
063         * if the mapping physical path and archive is invalid or not defined, it is possible this method returns null
064     * @return base Resource
065     */
066        public Resource getResource();
067    
068}