Package com.perforce.p4java.core.file

Enum FileAction

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FileAction>
    public enum FileAction
extends java.lang.Enum<FileAction>
    Defines the possible Perforce actions that can be associated with a Perforce file, including synchronization actions. Also used to indicate open status for files on pending changelists, resolve status, etc.

    Basically self-explanatory if you have much experience with Perforce, but if not, the main Perforce documentation goes into great detail about each of these actions.

    • Method Detail

      • values

        public static FileAction[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (FileAction c : FileAction.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static FileAction valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • fromString

        public static FileAction fromString​(java.lang.String str)
        A user-friendly fail-safe way to convert from strings to file actions without generating exceptions, etc.
        Parameters:
        str - upper, lower, or mixed-case candidate string, or null
        Returns:
        null if no match or if str was null, otherwise returns the closest matching file action

      • toString

        public java.lang.String toString()
        Provide a string representation that looks like the same actions seen through the p4 command interpreter rather than the raw enum.
        Overrides:
        toString in class java.lang.Enum<FileAction>
        See Also:
        Enum.toString()