Package org.apache.commons.vfs2

Enum FileType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FileType>
    public enum FileType
extends java.lang.Enum<FileType>
    An enumerated type that represents a file's type.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FILE
      A regular file.
      FILE_OR_FOLDER
      A file or folder.
      FOLDER
      A folder.
      IMAGINARY
      A file that does not exist.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getName()
      Returns the name of this type.
      boolean hasAttributes()
      Returns true if files of this type may have attributes.
      boolean hasChildren()
      Returns true if files of this type may contain other files.
      boolean hasContent()
      Returns true if files of this type may have data content.
      java.lang.String toString()
      Returns the name of this type.
      static FileType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FileType[] 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, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • FOLDER

        public static final FileType FOLDER
        A folder. May contain other files, and have attributes, but does not have any data content.

      • FILE

        public static final FileType FILE
        A regular file. May have data content and attributes, but cannot contain other files.

      • FILE_OR_FOLDER

        public static final FileType FILE_OR_FOLDER
        A file or folder. May have data content and attributes, and can contain other files.

      • IMAGINARY

        public static final FileType IMAGINARY
        A file that does not exist. May not have data content, attributes, or contain other files.

    • Method Detail

      • values

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

      • valueOf

        public static FileType 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

      • getName

        public java.lang.String getName()
        Returns the name of this type.
        Returns:
        The name of the type.

      • hasAttributes

        public boolean hasAttributes()
        Returns true if files of this type may have attributes.
        Returns:
        true if files can have attributes

      • hasChildren

        public boolean hasChildren()
        Returns true if files of this type may contain other files.
        Returns:
        true if files can contain other files.

      • hasContent

        public boolean hasContent()
        Returns true if files of this type may have data content.
        Returns:
        true if files can have content.

      • toString

        public java.lang.String toString()
        Returns the name of this type.
        Overrides:
        toString in class java.lang.Enum<FileType>
        Returns:
        The name of this type.