KickJava   Java API By Example, From Geeks To Geeks.

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


1 /**
2  * <copyright>
3  *
4  * Copyright (c) 2003-2005 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: ChangeDescription.java,v 1.5 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.common.util.EMap;
22 import org.eclipse.emf.ecore.EObject;
23
24
25 /**
26  * <!-- begin-user-doc -->
27  * A representation of the model object '<em><b>Description</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.ChangeDescription#getObjectChanges <em>Object Changes</em>}</li>
34  * <li>{@link org.eclipse.emf.ecore.change.ChangeDescription#getObjectsToDetach <em>Objects To Detach</em>}</li>
35  * <li>{@link org.eclipse.emf.ecore.change.ChangeDescription#getObjectsToAttach <em>Objects To Attach</em>}</li>
36  * <li>{@link org.eclipse.emf.ecore.change.ChangeDescription#getResourceChanges <em>Resource Changes</em>}</li>
37  * </ul>
38  * </p>
39  *
40  * @see org.eclipse.emf.ecore.change.ChangePackage#getChangeDescription()
41  * @model
42  * @generated
43  */
44 public interface ChangeDescription extends EObject{
45   /**
46    * Returns the value of the '<em><b>Object Changes</b></em>' map.
47    * The key is of type {@link org.eclipse.emf.ecore.EObject},
48    * and the value is of type list of {@link org.eclipse.emf.ecore.change.FeatureChange},
49    * <!-- begin-user-doc -->
50    * <p>
51    * If the meaning of the '<em>Object Changes</em>' map isn't clear,
52    * there really should be more of a description here...
53    * </p>
54    * <!-- end-user-doc -->
55    * @return the value of the '<em>Object Changes</em>' map.
56    * @see org.eclipse.emf.ecore.change.ChangePackage#getChangeDescription_ObjectChanges()
57    * @model mapType="org.eclipse.emf.ecore.change.EObjectToChangesMapEntry" keyType="org.eclipse.emf.ecore.EObject" valueType="org.eclipse.emf.ecore.change.FeatureChange"
58    * @generated
59    */
60   EMap getObjectChanges();
61
62   /**
63    * Returns the value of the '<em><b>Objects To Detach</b></em>' reference list.
64    * The list contents are of type {@link org.eclipse.emf.ecore.EObject}.
65    * <!-- begin-user-doc -->
66    * <p>
67    * Returns the list of objects that will be detached when this Change Description
68    * is applied. The list is calculated every time this method is called.
69    * </p>
70    * <!-- end-user-doc -->
71    * @return the value of the '<em>Objects To Detach</em>' reference list.
72    * @see org.eclipse.emf.ecore.change.ChangePackage#getChangeDescription_ObjectsToDetach()
73    * @model type="org.eclipse.emf.ecore.EObject" resolveProxies="false" transient="true" derived="true"
74    * @generated
75    */
76   EList getObjectsToDetach();
77
78   /**
79    * Returns the value of the '<em><b>Objects To Attach</b></em>' containment reference list.
80    * The list contents are of type {@link org.eclipse.emf.ecore.EObject}.
81    * <!-- begin-user-doc -->
82    * <p>
83    * If the meaning of the '<em>Objects To Attach</em>' containment reference list isn't clear,
84    * there really should be more of a description here...
85    * </p>
86    * <!-- end-user-doc -->
87    * @return the value of the '<em>Objects To Attach</em>' containment reference list.
88    * @see org.eclipse.emf.ecore.change.ChangePackage#getChangeDescription_ObjectsToAttach()
89    * @model type="org.eclipse.emf.ecore.EObject" containment="true" resolveProxies="false"
90    * @generated
91    */
92   EList getObjectsToAttach();
93
94   /**
95    * Returns the value of the '<em><b>Resource Changes</b></em>' containment reference list.
96    * The list contents are of type {@link org.eclipse.emf.ecore.change.ResourceChange}.
97    * <!-- begin-user-doc -->
98    * <p>
99    * If the meaning of the '<em>Resource Changes</em>' containment reference list isn't clear,
100    * there really should be more of a description here...
101    * </p>
102    * <!-- end-user-doc -->
103    * @return the value of the '<em>Resource Changes</em>' containment reference list.
104    * @see org.eclipse.emf.ecore.change.ChangePackage#getChangeDescription_ResourceChanges()
105    * @model type="org.eclipse.emf.ecore.change.ResourceChange" containment="true"
106    * @generated
107    */
108   EList getResourceChanges();
109
110   /**
111    * <!-- begin-user-doc -->
112    * <!-- end-user-doc -->
113    * @model
114    * @generated
115    */
116   void apply();
117
118   /**
119    * <!-- begin-user-doc -->
120    * <!-- end-user-doc -->
121    * @model
122    * @generated
123    */
124   void applyAndReverse();
125
126 } // ChangeDescription
127
Popular Tags