Extension SDK 9.0.5

oracle.jdeveloper.vcs.util
Class VCSCommandUtils

java.lang.Object
  extended byoracle.jdeveloper.vcs.util.VCSCommandUtils

public class VCSCommandUtils
extends java.lang.Object

Utility class for version control client commands.

Since:
9.0.5

Method Summary
static void closeMissingDocuments(Document[] documents)
          Closes all of the given documents whose files are absent on disk.
static java.util.Collection getCandidateSelection(Locatable[] locatables, VCSStatusCache cache)
          Gets the locatable selection whose files are candidates to be added.
static java.util.Collection getFilteredSelection(Locatable[] locatables, VCSStatusCache cache, VCSStatus[] statuses)
          Gets the locatable selection, filtered for the given file statuses.
static java.util.Collection getVersionedSelection(Locatable[] locatables, VCSStatusCache cache)
          Gets the locatable selection whose files are versioned.
static boolean saveDirtyDocuments(Locatable[] locatables, boolean silent, java.lang.String helpTopicId)
          Saves all of the given documents which are dirty, optionally prompting the user for confirmation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getFilteredSelection

public static final java.util.Collection getFilteredSelection(Locatable[] locatables,
                                                              VCSStatusCache cache,
                                                              VCSStatus[] statuses)
                                                       throws java.lang.Exception
Gets the locatable selection, filtered for the given file statuses.

Parameters:
locatables - the locatable selection.
cache - the status cache to use.
statuses - the statuses to accept.
Returns:
the selection of locatables filtered by state.
Throws:
java.lang.Exception - if a critical exception occurred.

getVersionedSelection

public static final java.util.Collection getVersionedSelection(Locatable[] locatables,
                                                               VCSStatusCache cache)
                                                        throws java.lang.Exception
Gets the locatable selection whose files are versioned.

Parameters:
locatables - the locatable selection.
cache - the status cache to use.
Returns:
the selection of locatables with versioned files.
Throws:
java.lang.Exception - if a critical exception occurred.

getCandidateSelection

public static final java.util.Collection getCandidateSelection(Locatable[] locatables,
                                                               VCSStatusCache cache)
                                                        throws java.lang.Exception
Gets the locatable selection whose files are candidates to be added.

Parameters:
locatables - the locatable selection.
cache - the status cache to use.
Returns:
the selection of locatables with candidate state files.
Throws:
java.lang.Exception - if a critical exception occurred.

saveDirtyDocuments

public static final boolean saveDirtyDocuments(Locatable[] locatables,
                                               boolean silent,
                                               java.lang.String helpTopicId)
                                        throws java.lang.Exception
Saves all of the given documents which are dirty, optionally prompting the user for confirmation.

Parameters:
silent - a decision on whether this method should operate silently.
helpTopicId - the help topic ID for the dialog. (null-capable)
Returns:
a verdict on whether files were saved, false if the user cancelled or an exception occurred.
Throws:
java.lang.Exception

closeMissingDocuments

public static final void closeMissingDocuments(Document[] documents)
Closes all of the given documents whose files are absent on disk.


Extension SDK

 

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