Package org.dspace.curate
Enum CurationClientOptions
- java.lang.Object
-
- java.lang.Enum<CurationClientOptions>
-
- org.dspace.curate.CurationClientOptions
-
- All Implemented Interfaces:
Serializable,Comparable<CurationClientOptions>
public enum CurationClientOptions extends Enum<CurationClientOptions>
This Enum holds all the possible options and combinations for the Curation script- Author:
- Maria Verdonck (Atmire) on 23/06/2020
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description protected static org.apache.commons.cli.OptionsconstructOptions()This method will create all the possible Options for theCurationscript.protected static CurationClientOptionsgetClientOption(org.apache.commons.cli.CommandLine commandLine)This method resolves the CommandLine parameters to figure out which action the curation script should performstatic List<String>getTaskOptions()Creates list of the taskOptions' keys from the configs of plugin.named.org.dspace.curate.CurationTaskstatic CurationClientOptionsvalueOf(String name)Returns the enum constant of this type with the specified name.static CurationClientOptions[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
TASK
public static final CurationClientOptions TASK
-
QUEUE
public static final CurationClientOptions QUEUE
-
HELP
public static final CurationClientOptions HELP
-
-
Method Detail
-
values
public static CurationClientOptions[] 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 (CurationClientOptions c : CurationClientOptions.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CurationClientOptions 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 nameNullPointerException- if the argument is null
-
getClientOption
protected static CurationClientOptions getClientOption(org.apache.commons.cli.CommandLine commandLine)
This method resolves the CommandLine parameters to figure out which action the curation script should perform- Parameters:
commandLine- The relevant CommandLine for the curation script- Returns:
- The curation option to be ran, parsed from the CommandLine
-
constructOptions
protected static org.apache.commons.cli.Options constructOptions()
This method will create all the possible Options for theCurationscript. This will be used byCurationScriptConfiguration- Returns:
- The options for the
Curationscript
-
-