1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/*******************************************************************************
* Copyright (c) 2001, 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*
*******************************************************************************/
package org.eclipse.wst.sse.core.internal.provisional.model;
import java.io.IOException;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.content.IContentType;
import org.eclipse.wst.sse.core.internal.model.FactoryRegistry;
import org.eclipse.wst.sse.core.internal.provisional.IModelStateListener;
import org.eclipse.wst.sse.core.internal.provisional.IndexedRegion;
import org.eclipse.wst.sse.core.internal.provisional.text.IStructuredDocument;
/**
* IStructuredModel's are mainly interesting by their extensions and
* implementers. The main purposed of this abstraction it to provide a common
* way to manage models that have an associated structured documnet.
*
* @plannedfor 1.0
*
*/
public interface IStructuredModelProposed extends IAdaptable {
/**
* This API allows clients to declare that they are about to make a
* "large" change to the model. This change might be in terms of content
* or it might be in terms of the model id or base location.
*
* Note that in the case of embedded calls, notification to listeners is
* sent only once.
*
* Note that the client who is making these changes has the responsibility
* to restore the model's state once finished with the changes. See
* getMemento and restoreState.
*
* The method isModelStateChanging can be used by a client to determine if
* the model is already in a change sequence.
*
* This method is a matched pair to changedModel, and must be called
* before changedModel. A client should never call changedModel without
* calling aboutToChangeModel first nor call aboutToChangeModel without
* calling changedModel later from the same Thread.
*/
void aboutToChangeModel();
void addModelStateListener(IModelStateListener listener);
/**
* This API allows a client controlled way of notifying all ModelEvent
* listners that the model has been changed. This method is a matched pair
* to aboutToChangeModel, and must be called after aboutToChangeModel ...
* or some listeners could be left waiting indefinitely for the changed
* event. So, its suggested that changedModel always be in a finally
* clause. Likewise, a client should never call changedModel without
* calling aboutToChangeModel first.
*
* In the case of embedded calls, the notification is just sent once.
*
*/
void changedModel();
/**
* This is a client-defined value for what that client (and/or loader)
* considers the "base" of the structured model. Frequently the location
* is either a workspace root-relative path of a workspace resource or an
* absolute path in the local file system.
*/
IPath getLocation();
/**
* @return The associated content type identifier (String) for this model.
*/
IContentType getContentType() throws CoreException;
/**
*
* @return The model's FactoryRegistry. A model is not valid without one.
*/
FactoryRegistry getFactoryRegistry();
/**
* Return the index region at offset. Returns null if there is no
* IndexedRegion that contains offset.
*/
IndexedRegion getIndexedRegion(int offset);
/**
* ISSUE: do we want to provide this? How to ensure job/thread safety
*
* @return
*/
IndexedRegion[] getIndexedRegions();
/**
* Rreturns the IStructuredDocument that underlies this model
*
* @return
*/
IStructuredDocument getStructuredDocument();
/**
*
*/
boolean isDirty();
/**
* This method can be called to determine if the model is within a
* "aboutToChange" and "changed" sequence.
*/
public boolean isModelStateChanging();
/**
*
*/
boolean isNew();
boolean isReinitializationNeeded();
/**
* This is a combination of if the model is dirty and if the model is
* shared for write access. The last writer as the responsibility to be
* sure the user is prompted to save.
*/
public boolean isSaveNeeded();
/**
* newInstance is similar to clone, except that the newInstance contains
* no content. Its purpose is so clients can get a temporary, unmanaged,
* model of the same "type" as the original. Note: the client may still
* need to do some intialization of the model returned by newInstance,
* depending on desired use. For example, the only factories in the
* newInstance are those that would be normally be created for a model of
* the given contentType. Others are not copied automatically, and if
* desired, should be added by client.
*/
IStructuredModelProposed newInstance() throws IOException;
void removeModelStateListener(IModelStateListener listener);
}
|
