src/org/mozilla/javascript/SourceTextManager.java

   1 /* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-\r
   2  *\r
   3  * The contents of this file are subject to the Netscape Public\r
   4  * License Version 1.1 (the "License"); you may not use this file\r
   5  * except in compliance with the License. You may obtain a copy of\r
   6  * the License at http://www.mozilla.org/NPL/\r
   7  *\r
   8  * Software distributed under the License is distributed on an "AS\r
   9  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express oqr\r
  10  * implied. See the License for the specific language governing\r
  11  * rights and limitations under the License.\r
  12  *\r
  13  * The Original Code is Rhino code, released\r
  14  * May 6, 1999.\r
  15  *\r
  16  * The Initial Developer of the Original Code is Netscape\r
  17  * Communications Corporation.  Portions created by Netscape are\r
  18  * Copyright (C) 1997-1999 Netscape Communications Corporation. All\r
  19  * Rights Reserved.\r
  20  *\r
  21  * Contributor(s): \r
  22  * John Bandhauer\r
  23  *\r
  24  * Alternatively, the contents of this file may be used under the\r
  25  * terms of the GNU Public License (the "GPL"), in which case the\r
  26  * provisions of the GPL are applicable instead of those above.\r
  27  * If you wish to allow use of your version of this file only\r
  28  * under the terms of the GPL and not to allow others to use your\r
  29  * version of this file under the NPL, indicate your decision by\r
  30  * deleting the provisions above and replace them with the notice\r
  31  * and other provisions required by the GPL.  If you do not delete\r
  32  * the provisions above, a recipient may use your version of this\r
  33  * file under either the NPL or the GPL.\r
  34  */\r
  35 \r
  36 // DEBUG API class\r
  37 \r
  38 package org.mozilla.javascript;\r
  39 \r
  40 import java.util.Enumeration;\r
  41 \r
  42 /**\r
  43  * This interface supports managing incrementally updated source text.\r
  44  *\r
  45  * @see org.mozilla.javascript.SourceTextItem\r
  46  * @see org.mozilla.javascript.Context#setSourceTextManager\r
  47  * @author John Bandhauer\r
  48  */\r
  49 \r
  50 public interface SourceTextManager\r
  51 {\r
  52     /**\r
  53      * Create a new item.\r
  54      * <p>\r
  55      * A new item is always created. If an item with this name already exists, \r
  56      * then that preexisting iten is is set as invalid. \r
  57      *\r
  58      * @param name item name - in most embedings this will be a URL or filename\r
  59      * @return new item\r
  60      */\r
  61     public SourceTextItem newItem(String name);\r
  62 \r
  63     /**\r
  64      * Get an existing item.\r
  65      * <p>\r
  66      * If an item with this name already exists, then return it. Otherwise, \r
  67      * return null.\r
  68      *\r
  69      * @param name item name - in most embedings this will be a URL or filename\r
  70      * @return existing item (or null if none)\r
  71      */\r
  72     public SourceTextItem getItem(String name);\r
  73 \r
  74     /**\r
  75      * Get all items.\r
  76      * <p>\r
  77      * Takes a snapshot of the list of all items and returns an Enumeration.\r
  78      *\r
  79      * @return snapshot Enumeration of all items\r
  80      */\r
  81     public Enumeration     getAllItems();\r
  82 }    \r