com.perforce.p4java.core.file
Class FileStatOutputOptions

java.lang.Object
  extended by com.perforce.p4java.core.file.FileStatOutputOptions

public class FileStatOutputOptions
extends Object

A simple way to encapsulate the complex output options available for the IServer getExtendedFiles method. If you're not using that method, this class should probably be ignored, especially given the rather cavalier approach to implementation.

NOTE: this class will probably be refactored or replaced in the near-term future.

NOTE: no guidance is given here on how to use this class; please refer to the main Perforce fstat documentation for details of each option.


Constructor Summary
FileStatOutputOptions()
           
FileStatOutputOptions(boolean mappedFiles, boolean syncedFiles, boolean openedNotHeadRevFiles, boolean openedFiles, boolean openedResolvedFiles, boolean openedNeedsResolvingFiles)
           
FileStatOutputOptions(boolean mappedFiles, boolean syncedFiles, boolean openedNotHeadRevFiles, boolean openedFiles, boolean openedResolvedFiles, boolean openedNeedsResolvingFiles, boolean shelvedFiles)
           
 
Method Summary
 boolean isMappedFiles()
           
 boolean isOpenedFiles()
           
 boolean isOpenedNeedsResolvingFiles()
           
 boolean isOpenedNotHeadRevFiles()
           
 boolean isOpenedResolvedFiles()
           
 boolean isShelvedFiles()
           
 boolean isSyncedFiles()
           
 void setMappedFiles(boolean mappedFiles)
           
 void setOpenedFiles(boolean openedFiles)
           
 void setOpenedNeedsResolvingFiles(boolean openedNeedsResolvingFiles)
           
 void setOpenedNotHeadRevFiles(boolean openedNotHeadRevFiles)
           
 void setOpenedResolvedFiles(boolean openedResolvedFiles)
           
 void setShelvedFiles(boolean shelvedFiles)
           
 void setSyncedFiles(boolean syncedFiles)
           
 List<String> toStrings()
          Return a list of strings, one element for each enabled option.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileStatOutputOptions

public FileStatOutputOptions()

FileStatOutputOptions

public FileStatOutputOptions(boolean mappedFiles,
                             boolean syncedFiles,
                             boolean openedNotHeadRevFiles,
                             boolean openedFiles,
                             boolean openedResolvedFiles,
                             boolean openedNeedsResolvingFiles)

FileStatOutputOptions

public FileStatOutputOptions(boolean mappedFiles,
                             boolean syncedFiles,
                             boolean openedNotHeadRevFiles,
                             boolean openedFiles,
                             boolean openedResolvedFiles,
                             boolean openedNeedsResolvingFiles,
                             boolean shelvedFiles)
Method Detail

toStrings

public List<String> toStrings()
Return a list of strings, one element for each enabled option.

Returns:
non-null but possibly-empty list of strings.

isMappedFiles

public boolean isMappedFiles()

setMappedFiles

public void setMappedFiles(boolean mappedFiles)

isSyncedFiles

public boolean isSyncedFiles()

setSyncedFiles

public void setSyncedFiles(boolean syncedFiles)

isOpenedNotHeadRevFiles

public boolean isOpenedNotHeadRevFiles()

setOpenedNotHeadRevFiles

public void setOpenedNotHeadRevFiles(boolean openedNotHeadRevFiles)

isOpenedFiles

public boolean isOpenedFiles()

setOpenedFiles

public void setOpenedFiles(boolean openedFiles)

isOpenedResolvedFiles

public boolean isOpenedResolvedFiles()

setOpenedResolvedFiles

public void setOpenedResolvedFiles(boolean openedResolvedFiles)

isOpenedNeedsResolvingFiles

public boolean isOpenedNeedsResolvingFiles()

setOpenedNeedsResolvingFiles

public void setOpenedNeedsResolvingFiles(boolean openedNeedsResolvingFiles)

isShelvedFiles

public boolean isShelvedFiles()
Returns:
the shelvedFiles

setShelvedFiles

public void setShelvedFiles(boolean shelvedFiles)
Parameters:
shelvedFiles - the shelvedFiles to set


Copyright © 2015 Perforce Software. All Rights Reserved.