Enum FilePath.PathType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FilePath.PathType>
    Enclosing class:
    FilePath

    public static enum FilePath.PathType
    extends java.lang.Enum<FilePath.PathType>
    Defines the various types a Perforce file path can have.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CLIENT
      Path is a Perforce client path type.
      DEPOT
      Path is a Perforce depot path type.
      LOCAL
      Path is a Perforce local path type.
      ORIGINAL
      Path pseudo-type used to flag a path as being the "original" path spec for a file spec.
      UNKNOWN
      Unknown file path type.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static FilePath.PathType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FilePath.PathType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • ORIGINAL

        public static final FilePath.PathType ORIGINAL
        Path pseudo-type used to flag a path as being the "original" path spec for a file spec. See IFileSpec for an explanation of ORIGINAL path types.
      • DEPOT

        public static final FilePath.PathType DEPOT
        Path is a Perforce depot path type.
      • CLIENT

        public static final FilePath.PathType CLIENT
        Path is a Perforce client path type.
      • LOCAL

        public static final FilePath.PathType LOCAL
        Path is a Perforce local path type.
    • Method Detail

      • values

        public static FilePath.PathType[] 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 (FilePath.PathType c : FilePath.PathType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static FilePath.PathType 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