IImportExportConstants


1   /*******************************************************************************
2    * Copyright (c) 2000, 2006 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  
12  package org.eclipse.debug.internal.ui.importexport.breakpoints;
13  
14  /**
15   *
16   * XML tag constants for importing and exporting breakpoints
17   */
18  public interface IImportExportConstants {
19  
20      /**
21       * <p>
22       * The name for the top level node in the XMLMemento for storing/restoring breakpoint information.</br>
23       * 
24       * General formulation of the XMLMemento is as follows:</br>
25       * 
26       * breakpoints := (breakpoint)*</br>
27       * 
28       * breakpoint := resource</br>
29       * 
30       * resource := (marker)+</br>
31       * 
32       * marker := (attribs)+</br>
33       * </p> 
34       * @see WizardExportBreakpointsPage
35       * @see WizardImportBreakpointsPage
36       * 
37       */
38      public static final String   IE_NODE_BREAKPOINTS = "breakpoints"; //$NON-NLS-1$
39      
40      /**
41       * The name of the node type for each of the imported or exported breakpoints
42       * 
43       * @see WizardExportBreakpointsPage
44       * @see WizardImportBreakpointsPage
45       */
46      public static final String   IE_NODE_BREAKPOINT = "breakpoint"; //$NON-NLS-1$
47      
48      /**
49       * The ID for the classname node for exporting breakpoints from the wizards.
50       * This ID is searchable from the listing of XMLMementos gathered from the BreakPointManager.
51       * 
52       * @see WizardExportBreakpointsPage
53       * @see WizardImportBreakpointsPage
54       * @see XMLMemento->getChild(String)
55       */
56      public static final String   IE_NODE_CLASSNAME = "classname"; //$NON-NLS-1$
57      
58      /**
59       * <p>
60       * The generalized ID for each of the values stored in a markers' attribute map.
61       * Since a marker can have any number of attributes and or values, we use a 
62       * (name, value) paring in the XMLmemento to store them, without having a dependence upon what the attribute
63       * is or what type it is.
64       * </p>
65       * @see WizardExportBreakpointsPage
66       * @see WizardImportBreakpointsPage
67       */
68      public static final String   IE_NODE_VALUE = "value"; //$NON-NLS-1$
69      
70      /**
71       * Each breakpoint has an associated resource, which is described with this element
72       * name
73       * 
74       * @see WizardExportBreakpointsPage
75       * @see WizardImportBreakpointsPage
76       */
77      public static final String   IE_NODE_RESOURCE = "resource"; //$NON-NLS-1$
78      
79      /**
80       * To validate the resource when filtering importable breakpoints we need to know its path.
81       * This is the the name of XMLMemento node that stores that path.
82       * 
83       * @see WizardExportBreakpointsPage
84       * @see WizardImportBreakpointsPage
85       */
86      public static final String   IE_NODE_PATH = "path"; //$NON-NLS-1$
87      
88      /**
89       * To filter the type of path searched for within the workspace to allow for the filtering of 
90       * breakpoints for import, we need to know the type to filter for.
91       * 
92       * This is the name of the XMLMemento node that stores the type of the resource
93       * 
94       * @see WizardExportBreakpointsPage
95       * @see WizardImportBreakpointsPage
96       */
97      public static final String   IE_NODE_TYPE = "type"; //$NON-NLS-1$
98      
99      /**
100      * The name for the marker node in the corresponding XMLMemento
101      * 
102      * @see WizardExportBreakpointsPage
103      * @see WizardImportBreakpointsPage
104      */
105     public static final String   IE_NODE_MARKER = "marker"; //$NON-NLS-1$
106     
107     /**
108      * The name for a marker attribute node in the corresponding XMLMemento
109      * 
110      * @see WizardExportBreakpointsPage
111      * @see WizardImportBreakpointsPage
112      */
113     public static final String   IE_NODE_ATTRIB = "attrib"; //$NON-NLS-1$
114     
115     /**
116      * The generalized name for the "name" node used in marker attribute nodes.
117      * This is the other ID in the (name, value) pairing used to describe attributes
118      * of markers.
119      * 
120      * @see WizardExportBreakpointsPage
121      * @see WizardImportBreakpointsPage
122      */
123     public static final String   IE_NODE_NAME = "name"; //$NON-NLS-1$
124     
125     /**
126      * The name of the enabled attribute, which is part of the breakpoint node information
127      * 
128      * @see WizardExportBreakpointsPage
129      * @see WizardImportBreakpointsPage
130      */
131     public static final String   IE_BP_ENABLED = "enabled"; //$NON-NLS-1$
132     
133     /**
134      * The name of the registered attribute, which is part of the breakpoint node information
135      * 
136      * @see WizardExportBreakpointsPage
137      * @see WizardImportBreakpointsPage
138      */
139     public static final String   IE_BP_REGISTERED = "registered"; //$NON-NLS-1$
140     
141     /**
142      * The name of the persistant attribute for breakpoint information
143      */
144     public static final String   IE_BP_PERSISTANT = "persistant"; //$NON-NLS-1$
145     
146     /**
147      * The default file extension for breakpoint export files
148      */
149     public static final String   EXTENSION = "bkpt";  //$NON-NLS-1$
150     
151     /**
152      * the charstart attribute from a marker
153      */
154     public static final String   CHARSTART = "charStart"; //$NON-NLS-1$
155     
156     /**
157      * the name of the workingsets node
158      */
159     public static final String   IE_NODE_WORKINGSETS = "workingsets";  //$NON-NLS-1$
160     
161     /**
162      * The name of the workingset node
163      */
164     public static final String   IE_NODE_WORKINGSET = "workingset"; //$NON-NLS-1$
165     
166     /**
167      * The name of the id attribute, reusable for a general attribute called id
168      */
169     public static final String   IE_NODE_ID = "id"; //$NON-NLS-1$
170     
171     /**
172      * The delimiter for the listing of working sets that a marker belongs to
173      */
174     public static final String   DELIMITER = "<;#>"; //$NON-NLS-1$
175 }//end interface
176
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags