JDeveloper SCM API

oracle.ide.scm.util
Class SCMFileSelection

java.lang.Object
  |
  +--oracle.ide.scm.util.SCMFileSelection

public final class SCMFileSelection
extends java.lang.Object

Class for the representation of a cross-folder selection of files.

Instances organize selected files by their respective parent folders, and provide convenient access to the data within this structure. This is useful in certain client operations where commands must be run on a per-folder basis. Note that the constructor of this class spends the given file iterator - if an operation uses a dialog specification, this will cause determinate progress indication to be misleading.


Constructor Summary
SCMFileSelection(java.util.Iterator files)
          Constructs a file selection for the given (SCMFiles).
 
Method Summary
 java.util.List getFileList()
          Gets the selection of files in all folders.
 java.util.Iterator getParentFolders()
          Gets the parent folder keys for the selection.
 java.util.List getSelectedFileNames(SCMFile folder)
          Gets the file names for the file selection in the given folder.
 java.util.List getSelectedFiles(SCMFile folder)
          Gets the selection of files in the given folder.
 java.util.List getSelectedPaths(SCMFile folder)
          Gets the paths for the file selection in the given folder.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SCMFileSelection

public SCMFileSelection(java.util.Iterator files)
Constructs a file selection for the given (SCMFiles).

Method Detail

getParentFolders

public final java.util.Iterator getParentFolders()
Gets the parent folder keys for the selection.

Returns:
an iterator over parent folder (SCMFiles).

getFileList

public final java.util.List getFileList()
Gets the selection of files in all folders.

Returns:
a list of selected files (SCMFiles).

getSelectedFiles

public final java.util.List getSelectedFiles(SCMFile folder)
Gets the selection of files in the given folder.

Returns:
a list of selected folder files (SCMFiles).

getSelectedFileNames

public final java.util.List getSelectedFileNames(SCMFile folder)
Gets the file names for the file selection in the given folder.

Returns:
a list of over selected file names (strings).

getSelectedPaths

public final java.util.List getSelectedPaths(SCMFile folder)
Gets the paths for the file selection in the given folder.

Returns:
a list of over selected file paths (strings).

Copyright © 2002 Oracle Corporation

 

Copyright ©1997, 2003, Oracle. All rights reserved.