Enum FilePathRestrictionInstance

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      LOCAL_OPTIONAL
      proscribe naming that probably causes sysadmin inconvenience on the current platform
      LOCAL_REQUIRED
      proscribe naming that probably causes system problems on the current platform
      UNIX_OPTIONAL
      proscribe naming that probably causes sysadmin inconvenience on UNIX-like platforms
      UNIX_REQUIRED
      proscribe naming that probably causes system problems on UNIX-like platforms
      WINDOWS_OPTIONAL
      proscribe naming that probably causes sysadmin inconvenience on Microsoft Windows
      WINDOWS_REQUIRED
      proscribe naming that probably causes system problems on Microsoft Windows
    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String name  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static FilePathRestrictions getFilePathRestrictions​(java.lang.String... names)
      Get a set of rules by which local files may not be named on the file-system, formed by combining the rules of the given names with rules against control characters.
      static FilePathRestrictions getFilePathRestrictions​(FilePathRestrictionInstance... enums)
      Get a set of rules by which local files may not be named on the file-system, formed by combining the given rules identifiers with rules against control characters.
      static FilePathRestrictionInstance valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FilePathRestrictionInstance[] 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

      • WINDOWS_REQUIRED

        public static final FilePathRestrictionInstance WINDOWS_REQUIRED
        proscribe naming that probably causes system problems on Microsoft Windows
      • WINDOWS_OPTIONAL

        public static final FilePathRestrictionInstance WINDOWS_OPTIONAL
        proscribe naming that probably causes sysadmin inconvenience on Microsoft Windows
      • UNIX_REQUIRED

        public static final FilePathRestrictionInstance UNIX_REQUIRED
        proscribe naming that probably causes system problems on UNIX-like platforms
      • UNIX_OPTIONAL

        public static final FilePathRestrictionInstance UNIX_OPTIONAL
        proscribe naming that probably causes sysadmin inconvenience on UNIX-like platforms
      • LOCAL_REQUIRED

        public static final FilePathRestrictionInstance LOCAL_REQUIRED
        proscribe naming that probably causes system problems on the current platform
      • LOCAL_OPTIONAL

        public static final FilePathRestrictionInstance LOCAL_OPTIONAL
        proscribe naming that probably causes sysadmin inconvenience on the current platform
    • Field Detail

      • name

        public final java.lang.String name
    • Method Detail

      • values

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

        public static FilePathRestrictionInstance 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
      • getFilePathRestrictions

        public static FilePathRestrictions getFilePathRestrictions​(java.lang.String... names)
        Get a set of rules by which local files may not be named on the file-system, formed by combining the rules of the given names with rules against control characters.
        Parameters:
        names - the names of the desired rules
        Returns:
        a rule set
      • getFilePathRestrictions

        public static FilePathRestrictions getFilePathRestrictions​(FilePathRestrictionInstance... enums)
        Get a set of rules by which local files may not be named on the file-system, formed by combining the given rules identifiers with rules against control characters.
        Parameters:
        enums - the names of the desired rules
        Returns:
        a rule set