Package MySTARS

Enum FileType

java.lang.Object
java.lang.Enum<FileType>
MySTARS.FileType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<FileType>, java.lang.constant.Constable
public enum FileType
extends java.lang.Enum<FileType>
FileType Enum that corresponds to the different files that the Application will use.
Since:
2020-11-1
Version:
1.0
Author:
Bhargav

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    COURSES
    File type corresponding to the Courses file.
    MISC
    File type corresponding to the Miscellaneous file.
    USERS
    File type corresponding to the Users file.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    java.lang.String fileName
    A String value for the FileType so that it is easy to retrieve.

  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    private FileType​(java.lang.String fileName)
    Initialiser for the FileType Enum.

  • Method Summary

    Modifier and Type Method Description
    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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • COURSES

      public static final FileType COURSES
      File type corresponding to the Courses file.

    • USERS

      public static final FileType USERS
      File type corresponding to the Users file.

    • MISC

      public static final FileType MISC
      File type corresponding to the Miscellaneous file.

  • Field Details

    • fileName

      public final java.lang.String fileName
      A String value for the FileType so that it is easy to retrieve.

  • Constructor Details

    • FileType

      private FileType​(java.lang.String fileName)
      Initialiser for the FileType Enum.
      Parameters:
      fileName - Assigns a fileName to each Enum value so files are easy to retrieve.

  • Method Details

    • values

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