Package org.dspace.curate

Enum Class CurationClientOptions

java.lang.Object

java.lang.Enum<CurationClientOptions>

org.dspace.curate.CurationClientOptions

All Implemented Interfaces:

Serializable, Comparable<CurationClientOptions>, Constable

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

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HELP
QUEUE
TASK

Method Summary

Modifier and Type	Method	Description
protected static org.apache.commons.cli.Options	constructOptions()	This method will create all the possible Options for the Curation script.
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
static List<String>	getTaskOptions()	Creates list of the taskOptions' keys from the configs of plugin.named.org.dspace.curate.CurationTask
static CurationClientOptions	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CurationClientOptions[]	values()	Returns an array containing the constants of this enum class, 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

TASK

public static final CurationClientOptions TASK

QUEUE

public static final CurationClientOptions QUEUE

HELP

public static final CurationClientOptions HELP

Method Details

values

public static CurationClientOptions[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CurationClientOptions valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - 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 the Curation script. This will be used by CurationScriptConfiguration

Returns:

The options for the Curation script

getTaskOptions

public static List<String> getTaskOptions()

Creates list of the taskOptions' keys from the configs of plugin.named.org.dspace.curate.CurationTask

Returns:

List of the taskOptions' keys from the configs of plugin.named.org.dspace.curate.CurationTask