Enum Location

  • All Implemented Interfaces:
    Serializable, Comparable<Location>

    public enum Location
    extends Enum<Location>
    This enumeration defines constants that are used to specify different file storage locations.
    Version:
    2.0
    Author:
    enell
    Last modified
    $Date: 2019-02-22 08:21:20 +0100 (fre, 22 feb. 2019) $
    • Enum Constant Detail

      • OFFLINE

        public static final Location OFFLINE
        The item is offline and doesn't use any quota.
      • PRIMARY

        public static final Location PRIMARY
        The item is stored in primary storage.
      • EXTERNAL

        public static final Location EXTERNAL
        The item is stored externally. Some information like size, md5, etc. may not be available.
        Since:
        2.16
    • Field Detail

      • valueMapping

        private static final Map<Integer,​Location> valueMapping
        Maps an integer to a location.
      • value

        private final int value
        The integer value of this location.
      • displayValue

        private final String displayValue
        Returned by the toString method.
      • downloadable

        private final boolean downloadable
        If the file can be downloaded from this location.
      • quotaLimited

        private final boolean quotaLimited
        If this location is limited by quota.
    • Constructor Detail

      • Location

        private Location​(int value,
                         String displayValue,
                         boolean downloadable,
                         boolean quotaLimited)
        Creates a new location. Used internal only.
        Parameters:
        value - The integer value of this location.
    • Method Detail

      • values

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

        public static Location valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • fromValue

        public static Location fromValue​(int value)
        Get the Location object when you know the integer code.
        Parameters:
        value - The integer value.
        Returns:
        The location for the integer value.
      • getValue

        public int getValue()
        Get the integer value that is used when storing an location to the database.
        Returns:
        The integer value for this location.
      • isQuotaLimited

        public boolean isQuotaLimited()
        A flag indicating if a file that is stored at this location should be included in quota limit.
        Returns:
        TRUE if this location is quota limited, FALSE otherwise
        Since:
        2.16