Package com.perforce.p4java.impl.mapbased.client.cmd

Class WhereDelegator

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<IFileSpec> localWhere​(java.util.List<IFileSpec> fileSpecs)
      For each of the passed-in file specs, show how the named file maps through the client view.
      java.util.List<IFileSpec> where​(java.util.List<IFileSpec> fileSpecs)
      For each of the passed-in file specs, show how the named file maps through the client view.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • WhereDelegator

        public WhereDelegator​(IServer server,
                      IClient client)

    • Method Detail

      • where

        public java.util.List<IFileSpec> where​(java.util.List<IFileSpec> fileSpecs)
                                throws ConnectionException,
                                       AccessException
        Description copied from interface: IWhereDelegator
        For each of the passed-in file specs, show how the named file maps through the client view.

        Note that this method will return an empty list unless the client is the IServer object's current client.

        The returned IFiles contain all three of the depot, client, and local file paths of the corresponding fileSpec array element where appropriate, or the usual server-generated error message if there was no corresponding mapping. The main exception to this is the case when no filespecs are given (i.e. the fileSpecs array is null or empty), when the mappings for '...' (all files in the current directory and below) are returned (if they exist).

        Specified by:
        where in interface IWhereDelegator
        Parameters:
        fileSpecs - a list of Perforce file specifications; can be empty or even null (see explanation above).
        Returns:
        a non-null (but possibly empty) list of IFileSpec for the input filespecs.
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IWhereDelegator.where(java.util.List)

      • localWhere

        public java.util.List<IFileSpec> localWhere​(java.util.List<IFileSpec> fileSpecs)
        Description copied from interface: IWhereDelegator
        For each of the passed-in file specs, show how the named file maps through the client view.

        Note that this method will return an empty list unless the client is the IServer object's current client.

        The returned IFiles contain all three of the depot, client, and local file paths of the corresponding fileSpec array element where appropriate, or the usual server-generated error message if there was no corresponding mapping. The main exception to this is the case when no filespecs are given (i.e. the fileSpecs array is null or empty), when the mappings for '...' (all files in the current directory and below) are returned (if they exist).

        Assumes depot syntax is used for original path.

        Specified by:
        localWhere in interface IWhereDelegator
        Parameters:
        fileSpecs - a list of Perforce file specifications; can be empty or even null (see explanation above).
        Returns:
        a non-null (but possibly empty) list of IFileSpec for the input filespecs.
        See Also:
        IWhereDelegator.localWhere(java.util.List)