Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> pde >> [ core overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.eclipse.pde.core
Interface IModel  

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IBaseModel

---

public interface IModel

extends IBaseModel

A generic model. Classes that implement this interface are expected to be able to:

• Load from an input stream
• Reload (reset, load, fire 'world change')
• Dispose (clear all the data and reset)
• Be associated with a resource (optional)

If a model is not created from a workspace resource file, its underlying resource will be null .

Since:

2.0

---

Method Summary
java.lang.String	getResourceString(java.lang.String key)           Returns a string found in the resource bundle associated with this model for the provided key.
long	getTimeStamp()           Returns the last modification time stamp.
org.eclipse.core.resources.IResource	getUnderlyingResource()           Returns a workspace resource that this model is created from.
boolean	isInSync()           Tests if this model is in sync with the storage object it was loaded from.
boolean	isLoaded()           Tests if this model is loaded and can be used.
boolean	isReconcilingModel()           Returns whether this model needs to react to changes in source and reconcile them.
void	load()           Loads the model directly from an underlying resource.
void	load(java.io.InputStream source, boolean outOfSync)           Loads the model from the provided input stream.
void	reload(java.io.InputStream source, boolean outOfSync)           Reload is a version of 'load' operation that has the following steps: Reset the model Load the model Fire "world changed" event Reload operation is used when a model that is already in use is invalidated by a change in the underlying buffer or resource.

 

Methods inherited from interface org.eclipse.pde.core.IBaseModel

dispose, isDisposed, isEditable, isValid

 

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

 

Method Detail

getResourceString

public java.lang.String getResourceString(java.lang.String key)

Returns a string found in the resource bundle associated with this model for the provided key.

---

getUnderlyingResource

public org.eclipse.core.resources.IResource getUnderlyingResource()

Returns a workspace resource that this model is created from. Load/reload operations are not directly connected with the resource (although they can be). In some cases, models will load from a buffer (an editor document) rather than a resource. However, the buffer will eventually be synced up with this resource.

With the caveat of stepped loading, all other properties of the underlying resource could be used directly (path, project etc.).

---

isLoaded

public boolean isLoaded()

Tests if this model is loaded and can be used.

---

isInSync

public boolean isInSync()

Tests if this model is in sync with the storage object it was loaded from. Models loaded from resources are in sync if underlying resources are in sync. Models loaded from files on the file systems are in sync if the time stamp matches the model time stamp.

---

getTimeStamp

public long getTimeStamp()

Returns the last modification time stamp. The model itself does not have the time stamp. It is 'borrowed' from the underlying physical object.

---

load

public void load()
          throws org.eclipse.core.runtime.CoreException

Loads the model directly from an underlying resource. This method does nothing if this model has no underlying resource or if there is a buffer stage between the model and the resource.

---

load

public void load(java.io.InputStream source,
                 boolean outOfSync)
          throws org.eclipse.core.runtime.CoreException

Loads the model from the provided input stream. This method throws a CoreException if errors are encountered during the loading. Upon succesful load, 'isLoaded()' should return true .

---

reload

public void reload(java.io.InputStream source,
                   boolean outOfSync)
            throws org.eclipse.core.runtime.CoreException

Reload is a version of 'load' operation that has the following steps:

• Reset the model
• Load the model
• Fire "world changed" event

Reload operation is used when a model that is already in use is invalidated by a change in the underlying buffer or resource. Since we don't know the extent of the change, the only safe thing to do is to reparse the buffer to sync up. The event that is subsequently fired should be used by listeners to discard all caches and/or fully refresh views that shows any portion of the model.

---

isReconcilingModel

public boolean isReconcilingModel()

Returns whether this model needs to react to changes in source and reconcile them. Only model instances used in editors need to perform this task.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> pde >> [ core overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---