Package com.jalios.jcms.fileprocessor.ui

Enum FileProcessorAction

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FileProcessorAction>
    public enum FileProcessorAction
extends java.lang.Enum<FileProcessorAction>
    FileProcessor action which can be triggered by administrators.
    Since:
    JCMS-5109

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract void process​(boolean first, Repository repository, java.lang.String[] filesShortName, java.lang.Class<? extends FileActionComponent> actionComponentClass)
      Process the action.
      static FileProcessorAction valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FileProcessorAction[] 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

    • Method Detail

      • values

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

      • valueOf

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

      • process

        public abstract void process​(boolean first,
                             Repository repository,
                             java.lang.String[] filesShortName,
                             java.lang.Class<? extends FileActionComponent> actionComponentClass)
        Process the action.
        Parameters:
        first - set to true if method is invoked on the replica on which action was requested, false if action is the replay on other replica
        repository - the repository for which action is performed, must not be null
        filesShortName - the files on which action is applied (path relative to repository base directory), must not be null
        actionComponentClass - an optional component class on which action is filtered