KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > emf > ecore > change > ListChange


1 /**
2  * <copyright>
3  *
4  * Copyright (c) 2003-2004 IBM Corporation and others.
5  * All rights reserved. This program and the accompanying materials
6  * are made available under the terms of the Eclipse Public License v1.0
7  * which accompanies this distribution, and is available at
8  * http://www.eclipse.org/legal/epl-v10.html
9  *
10  * Contributors:
11  * IBM - Initial API and implementation
12  *
13  * </copyright>
14  *
15  * $Id: ListChange.java,v 1.6 2005/06/08 06:16:16 nickb Exp $
16  */
17 package org.eclipse.emf.ecore.change;
18
19
20 import org.eclipse.emf.common.util.EList;
21 import org.eclipse.emf.ecore.EObject;
22 import org.eclipse.emf.ecore.EStructuralFeature;
23
24
25 /**
26  * <!-- begin-user-doc -->
27  * A representation of the model object '<em><b>List Change</b></em>'.
28  * <!-- end-user-doc -->
29  *
30  * <p>
31  * The following features are supported:
32  * <ul>
33  * <li>{@link org.eclipse.emf.ecore.change.ListChange#getKind <em>Kind</em>}</li>
34  * <li>{@link org.eclipse.emf.ecore.change.ListChange#getDataValues <em>Data Values</em>}</li>
35  * <li>{@link org.eclipse.emf.ecore.change.ListChange#getIndex <em>Index</em>}</li>
36  * <li>{@link org.eclipse.emf.ecore.change.ListChange#getMoveToIndex <em>Move To Index</em>}</li>
37  * <li>{@link org.eclipse.emf.ecore.change.ListChange#getValues <em>Values</em>}</li>
38  * <li>{@link org.eclipse.emf.ecore.change.ListChange#getReferenceValues <em>Reference Values</em>}</li>
39  * <li>{@link org.eclipse.emf.ecore.change.ListChange#getFeature <em>Feature</em>}</li>
40  * <li>{@link org.eclipse.emf.ecore.change.ListChange#getFeatureMapEntryValues <em>Feature Map Entry Values</em>}</li>
41  * </ul>
42  * </p>
43  *
44  * @see org.eclipse.emf.ecore.change.ChangePackage#getListChange()
45  * @model
46  * @generated
47  */
48 public interface ListChange extends EObject
49 {
50   /**
51    * Returns the value of the '<em><b>Kind</b></em>' attribute.
52    * The literals are from the enumeration {@link org.eclipse.emf.ecore.change.ChangeKind}.
53    * <!-- begin-user-doc -->
54    * <p>
55    * If the meaning of the '<em>Kind</em>' attribute isn't clear,
56    * there really should be more of a description here...
57    * </p>
58    * <!-- end-user-doc -->
59    * @return the value of the '<em>Kind</em>' attribute.
60    * @see org.eclipse.emf.ecore.change.ChangeKind
61    * @see #setKind(ChangeKind)
62    * @see org.eclipse.emf.ecore.change.ChangePackage#getListChange_Kind()
63    * @model
64    * @generated
65    */
66   ChangeKind getKind();
67
68   /**
69    * Sets the value of the '{@link org.eclipse.emf.ecore.change.ListChange#getKind <em>Kind</em>}' attribute.
70    * <!-- begin-user-doc -->
71    * <!-- end-user-doc -->
72    * @param value the new value of the '<em>Kind</em>' attribute.
73    * @see org.eclipse.emf.ecore.change.ChangeKind
74    * @see #getKind()
75    * @generated
76    */
77   void setKind(ChangeKind value);
78
79   /**
80    * Returns the value of the '<em><b>Data Values</b></em>' attribute list.
81    * The list contents are of type {@link java.lang.String}.
82    * <!-- begin-user-doc -->
83    * <p>
84    * If the meaning of the '<em>Data Values</em>' attribute list isn't clear,
85    * there really should be more of a description here...
86    * </p>
87    * <!-- end-user-doc -->
88    * @return the value of the '<em>Data Values</em>' attribute list.
89    * @see org.eclipse.emf.ecore.change.ChangePackage#getListChange_DataValues()
90    * @model type="java.lang.String"
91    * @generated
92    */
93   EList getDataValues();
94
95   /**
96    * Returns the value of the '<em><b>Index</b></em>' attribute.
97    * The default value is <code>"-1"</code>.
98    * <!-- begin-user-doc -->
99    * <p>
100    * If the meaning of the '<em>Index</em>' attribute isn't clear,
101    * there really should be more of a description here...
102    * </p>
103    * <!-- end-user-doc -->
104    * @return the value of the '<em>Index</em>' attribute.
105    * @see #setIndex(int)
106    * @see org.eclipse.emf.ecore.change.ChangePackage#getListChange_Index()
107    * @model default="-1"
108    * @generated
109    */
110   int getIndex();
111
112   /**
113    * Sets the value of the '{@link org.eclipse.emf.ecore.change.ListChange#getIndex <em>Index</em>}' attribute.
114    * <!-- begin-user-doc -->
115    * <!-- end-user-doc -->
116    * @param value the new value of the '<em>Index</em>' attribute.
117    * @see #getIndex()
118    * @generated
119    */
120   void setIndex(int value);
121
122   /**
123    * Returns the value of the '<em><b>Move To Index</b></em>' attribute.
124    * <!-- begin-user-doc -->
125    * <p>
126    * If the meaning of the '<em>Move To Index</em>' attribute isn't clear,
127    * there really should be more of a description here...
128    * </p>
129    * <!-- end-user-doc -->
130    * @return the value of the '<em>Move To Index</em>' attribute.
131    * @see #setMoveToIndex(int)
132    * @see org.eclipse.emf.ecore.change.ChangePackage#getListChange_MoveToIndex()
133    * @model
134    * @generated
135    */
136   int getMoveToIndex();
137
138   /**
139    * Sets the value of the '{@link org.eclipse.emf.ecore.change.ListChange#getMoveToIndex <em>Move To Index</em>}' attribute.
140    * <!-- begin-user-doc -->
141    * <!-- end-user-doc -->
142    * @param value the new value of the '<em>Move To Index</em>' attribute.
143    * @see #getMoveToIndex()
144    * @generated
145    */
146   void setMoveToIndex(int value);
147
148   /**
149    * Returns the value of the '<em><b>Reference Values</b></em>' reference list.
150    * The list contents are of type {@link org.eclipse.emf.ecore.EObject}.
151    * <!-- begin-user-doc -->
152    * <p>
153    * If the meaning of the '<em>Reference Values</em>' reference list isn't clear,
154    * there really should be more of a description here...
155    * </p>
156    * <!-- end-user-doc -->
157    * @return the value of the '<em>Reference Values</em>' reference list.
158    * @see org.eclipse.emf.ecore.change.ChangePackage#getListChange_ReferenceValues()
159    * @model type="org.eclipse.emf.ecore.EObject"
160    * @generated
161    */
162   EList getReferenceValues();
163
164   /**
165    * Returns the value of the '<em><b>Feature</b></em>' reference.
166    * <!-- begin-user-doc -->
167    * <p>
168    * If the meaning of the '<em>Feature</em>' reference isn't clear,
169    * there really should be more of a description here...
170    * </p>
171    * <!-- end-user-doc -->
172    * @return the value of the '<em>Feature</em>' reference.
173    * @see #setFeature(EStructuralFeature)
174    * @see org.eclipse.emf.ecore.change.ChangePackage#getListChange_Feature()
175    * @model
176    * @generated
177    */
178   EStructuralFeature getFeature();
179
180   /**
181    * Sets the value of the '{@link org.eclipse.emf.ecore.change.ListChange#getFeature <em>Feature</em>}' reference.
182    * <!-- begin-user-doc -->
183    * <!-- end-user-doc -->
184    * @param value the new value of the '<em>Feature</em>' reference.
185    * @see #getFeature()
186    * @generated
187    */
188   void setFeature(EStructuralFeature value);
189
190   /**
191    * Returns the value of the '<em><b>Feature Map Entry Values</b></em>' containment reference list.
192    * The list contents are of type {@link org.eclipse.emf.ecore.change.FeatureMapEntry}.
193    * <!-- begin-user-doc -->
194    * <p>
195    * If the meaning of the '<em>Feature Map Entry Values</em>' containment reference list isn't clear,
196    * there really should be more of a description here...
197    * </p>
198    * <!-- end-user-doc -->
199    * @return the value of the '<em>Feature Map Entry Values</em>' containment reference list.
200    * @see org.eclipse.emf.ecore.change.ChangePackage#getListChange_FeatureMapEntryValues()
201    * @model type="org.eclipse.emf.ecore.change.FeatureMapEntry" containment="true"
202    * @generated
203    */
204   EList getFeatureMapEntryValues();
205
206   /**
207    * Returns the value of the '<em><b>Values</b></em>' attribute list.
208    * The list contents are of type {@link java.lang.Object}.
209    * <!-- begin-user-doc -->
210    * <!-- end-user-doc -->
211    * @return the value of the '<em>Values</em>' attribute list.
212    * @see org.eclipse.emf.ecore.change.ChangePackage#getListChange_Values()
213    * @model type="java.lang.Object" transient="true" volatile="true" derived="true"
214    * @generated
215    */
216   EList getValues();
217
218   /**
219    * <!-- begin-user-doc -->
220    * <!-- end-user-doc -->
221    * @model originalListMany="false"
222    * @generated
223    */
224   void apply(EList originalList);
225
226   /**
227    * <!-- begin-user-doc -->
228    * <!-- end-user-doc -->
229    * @model originalListMany="false"
230    * @generated
231    */
232   void applyAndReverse(EList originalList);
233
234 } // ListChange
235
Popular Tags