|
JDeveloper SCM API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface to a extension's file system, provided for general IDE integration.
All methods defined by this interface are optionally implementable, since URLFileSystem will be used by default. However, in supplying the implementation of these methods the extension can support version-safe operations on files for interactions within the tool. These operations are made available to extensions through the IDE's version system.
To provide support for one of the common file system actions, ensure that the relevant query method corresponding to the action returns true. The source control framework's interface for the runtime invocation of SCM extension operations (SCMOperationRuntime) may be used to handle these actions if preferred.
When providing a file system for a client, use the operations of the
filename abstraction SCMFile
wherever possible. These methods
provide support for model and node updating, and also have superior error
checking.
Method Summary | |
void |
add(SCMFile[] files)
Adds the given files to source control. |
void |
edit(SCMFile[] files)
Edits, or prepares for editing the given files to source control. |
boolean |
isAddSupported()
Asks whether the add(oracle.ide.scm.SCMFile[]) method is supported by this file system. |
boolean |
isEditSupported()
Asks whether the edit(oracle.ide.scm.SCMFile[]) method is supported by this file system. |
boolean |
isMoveSupported()
Asks whether the move(oracle.ide.scm.SCMFile[], oracle.ide.scm.SCMFile[]) method is supported by this file system. |
boolean |
isRemoveSupported()
Asks whether the remove(oracle.ide.scm.SCMFile[]) method is supported by this file system. |
void |
move(SCMFile[] srcs,
SCMFile[] dsts)
Moves the given source files to corresponding destinations through source control. |
void |
remove(SCMFile[] files)
Removes the given files from source control. |
Method Detail |
public boolean isAddSupported()
add(oracle.ide.scm.SCMFile[])
method is supported by this file system.public void add(SCMFile[] files) throws SCMException
Parameter-related preconditions for this method:
files
- an array of files to add.public boolean isEditSupported()
edit(oracle.ide.scm.SCMFile[])
method is supported by this file system.public void edit(SCMFile[] files) throws SCMException
Parameter-related preconditions for this method:
files
- an array of files to add.public boolean isMoveSupported()
move(oracle.ide.scm.SCMFile[], oracle.ide.scm.SCMFile[])
method is supported by this file system.public void move(SCMFile[] srcs, SCMFile[] dsts) throws SCMException
Parameter-related preconditions for this method:
srcs
- an array of source files to move.dsts
- an array of file destinations for the move.public boolean isRemoveSupported()
remove(oracle.ide.scm.SCMFile[])
method is supported by this file system.public void remove(SCMFile[] files) throws SCMException
Parameter-related preconditions for this method:
files
- an array of files to remove.
|
Copyright © 2002 Oracle Corporation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |