Eclipse CDT
Pre-release 3.0

org.eclipse.cdt.core.model
Interface ICModel

All Superinterfaces:
IBufferChangedListener, ICElement, IOpenable, IParent

public interface ICModel
extends ICElement, IParent, IOpenable

Represent the root C element corresponding to the workspace. Since there is only one such root element, it is commonly referred to as the C model element. The C model element needs to be opened before it can be navigated or manipulated. The C model element has no parent (it is the root of the C element hierarchy). Its children are ICProjects.

This interface provides methods for performing copy, move, rename, and delete operations on multiple C elements.

See Also:
CCore#create(org.eclipse.core.resources.IWorkspaceRoot)

Field Summary
 
Fields inherited from interface org.eclipse.cdt.core.model.ICElement
C_ARCHIVE, C_BINARY, C_CCONTAINER, C_CLASS, C_CLASS_CTOR, C_CLASS_DECLARATION, C_CLASS_DTOR, C_ENUMERATION, C_ENUMERATOR, C_FIELD, C_FUNCTION, C_FUNCTION_DECLARATION, C_INCLUDE, C_MACRO, C_METHOD, C_METHOD_DECLARATION, C_MODEL, C_NAMESPACE, C_PROJECT, C_STORAGE_EXTERN, C_STORAGE_STATIC, C_STRUCT, C_STRUCT_DECLARATION, C_TEMPLATE_CLASS, C_TEMPLATE_CLASS_DECLARATION, C_TEMPLATE_FUNCTION, C_TEMPLATE_FUNCTION_DECLARATION, C_TEMPLATE_METHOD, C_TEMPLATE_METHOD_DECLARATION, C_TEMPLATE_STRUCT, C_TEMPLATE_STRUCT_DECLARATION, C_TEMPLATE_UNION, C_TEMPLATE_UNION_DECLARATION, C_TEMPLATE_VARIABLE, C_TYPEDEF, C_UNION, C_UNION_DECLARATION, C_UNIT, C_UNKNOWN_DECLARATION, C_USING, C_VARIABLE, C_VARIABLE_DECLARATION, C_VARIABLE_LOCAL, C_VCONTAINER, CPP_FRIEND, CPP_PRIVATE, CPP_PROTECTED, CPP_PUBLIC
 
Method Summary
 void copy(ICElement[] elements, ICElement[] containers, ICElement[] siblings, String[] renamings, boolean replace, IProgressMonitor monitor)
          Copies the given elements to the specified container(s).
 void delete(ICElement[] elements, boolean force, IProgressMonitor monitor)
          Deletes the given elements, forcing the operation if necessary and specified.
 ICProject getCProject(String name)
          Returns the C project with the given name.
 ICProject[] getCProjects()
          Returns the C projects.
 Object[] getNonCResources()
          Returns an array of non-C resources (i.e. non-C projects) in the workspace.
 IWorkspace getWorkspace()
          Returns the workspace associated with this C model.
 void move(ICElement[] elements, ICElement[] containers, ICElement[] siblings, String[] renamings, boolean replace, IProgressMonitor monitor)
          Moves the given elements to the specified container(s).
 void rename(ICElement[] elements, ICElement[] destinations, String[] names, boolean replace, IProgressMonitor monitor)
          Renames the given elements as specified.
 
Methods inherited from interface org.eclipse.cdt.core.model.ICElement
accept, exists, getAncestor, getCModel, getCProject, getElementName, getElementType, getParent, getPath, getResource, getUnderlyingResource, isReadOnly, isStructureKnown
 
Methods inherited from interface org.eclipse.cdt.core.model.IParent
getChildren, getChildrenOfType, hasChildren
 
Methods inherited from interface org.eclipse.cdt.core.model.IOpenable
close, getBuffer, hasUnsavedChanges, isConsistent, isOpen, makeConsistent, makeConsistent, open, save
 
Methods inherited from interface org.eclipse.cdt.core.model.IBufferChangedListener
bufferChanged
 

Method Detail

copy

void copy(ICElement[] elements,
          ICElement[] containers,
          ICElement[] siblings,
          String[] renamings,
          boolean replace,
          IProgressMonitor monitor)
          throws CModelException
Copies the given elements to the specified container(s). If one container is specified, all elements are copied to that container. If more than one container is specified, the number of elements and containers must match, and each element is copied to its associated container.

Optionally, each copy can positioned before a sibling element. If null is specified for a given sibling, the copy is inserted as the last child of its associated container.

Optionally, each copy can be renamed. If null is specified for the new name, the copy is not renamed.

Optionally, any existing child in the destination container with the same name can be replaced by specifying true for force. Otherwise an exception is thrown in the event that a name collision occurs.

Parameters:
elements - the elements to copy
containers - the container, or list of containers
siblings - the list of siblings element any of which may be null; or null
renamings - the list of new names any of which may be null; or null
replace - true if any existing child in a target container with the target name should be replaced, and false to throw an exception in the event of a name collision
monitor - a progress monitor
Throws:
CModelException - if an element could not be copied. Reasons include:
  • A specified element, container, or sibling does not exist (ELEMENT_DOES_NOT_EXIST)
  • A CoreException occurred while updating an underlying resource
  • A container is of an incompatible type (INVALID_DESTINATION)
  • A sibling is not a child of it associated container (INVALID_SIBLING)
  • A new name is invalid (INVALID_NAME)
  • A child in its associated container already exists with the same name and replace has been specified as false (NAME_COLLISION)
  • A container or element is read-only (READ_ONLY)

delete

void delete(ICElement[] elements,
            boolean force,
            IProgressMonitor monitor)
            throws CModelException
Deletes the given elements, forcing the operation if necessary and specified.

Parameters:
elements - the elements to delete
force - a flag controlling whether underlying resources that are not in sync with the local file system will be tolerated
monitor - a progress monitor
Throws:
CModelException - if an element could not be deleted. Reasons include:
  • A specified element does not exist (ELEMENT_DOES_NOT_EXIST)
  • A CoreException occurred while updating an underlying resource
  • An element is read-only (READ_ONLY)

move

void move(ICElement[] elements,
          ICElement[] containers,
          ICElement[] siblings,
          String[] renamings,
          boolean replace,
          IProgressMonitor monitor)
          throws CModelException
Moves the given elements to the specified container(s). If one container is specified, all elements are moved to that container. If more than one container is specified, the number of elements and containers must match, and each element is moved to its associated container.

Optionally, each element can positioned before a sibling element. If null is specified for sibling, the element is inserted as the last child of its associated container.

Optionally, each element can be renamed. If null is specified for the new name, the element is not renamed.

Optionally, any existing child in the destination container with the same name can be replaced by specifying true for force. Otherwise an exception is thrown in the event that a name collision occurs.

Parameters:
elements - the elements to move
containers - the container, or list of containers
siblings - the list of siblings element any of which may be null; or null
renamings - the list of new names any of which may be null; or null
replace - true if any existing child in a target container with the target name should be replaced, and false to throw an exception in the event of a name collision
monitor - a progress monitor
Throws:
CModelException - if an element could not be moved. Reasons include:
  • A specified element, container, or sibling does not exist (ELEMENT_DOES_NOT_EXIST)
  • A CoreException occurred while updating an underlying resource
  • A container is of an incompatible type (INVALID_DESTINATION)
  • A sibling is not a child of it associated container (INVALID_SIBLING)
  • A new name is invalid (INVALID_NAME)
  • A child in its associated container already exists with the same name and replace has been specified as false (NAME_COLLISION)
  • A container or element is read-only (READ_ONLY)
IllegalArgumentException - any element or container is null

rename

void rename(ICElement[] elements,
            ICElement[] destinations,
            String[] names,
            boolean replace,
            IProgressMonitor monitor)
            throws CModelException
Renames the given elements as specified. If one container is specified, all elements are renamed within that container. If more than one container is specified, the number of elements and containers must match, and each element is renamed within its associated container.

Parameters:
elements - the elements to rename
destinations - the container, or list of containers
names - the list of new names
replace - true if an existing child in a target container with the target name should be replaced, and false to throw an exception in the event of a name collision
monitor - a progress monitor
Throws:
CModelException - if an element could not be renamed. Reasons include:
  • A specified element does not exist (ELEMENT_DOES_NOT_EXIST)
  • A CoreException occurred while updating an underlying resource
  • A new name is invalid (INVALID_NAME)
  • A child already exists with the same name and replace has been specified as false (NAME_COLLISION)
  • An element is read-only (READ_ONLY)

getCProject

ICProject getCProject(String name)
Returns the C project with the given name. This is a handle-only method. The project may or may not exist.

Parameters:
name - of the Project

getCProjects

ICProject[] getCProjects()
                         throws CModelException
Returns the C projects.

Throws:
CModelException

getNonCResources

Object[] getNonCResources()
                          throws CModelException
Returns an array of non-C resources (i.e. non-C projects) in the workspace.

Non-C projects include all projects that are closed (even if they have the C nature).

Returns:
an array of non-C projects contained in the workspace.
Throws:
CModelException - if this element does not exist or if an exception occurs while accessing its corresponding resource
Since:
2.1

getWorkspace

IWorkspace getWorkspace()
Returns the workspace associated with this C model.


Eclipse CDT
Pre-release 3.0

Copyright (c) IBM Corp. and others 2004. All Rights Reserved.