org.openimaj.tools.twitter.modes.output

Enum TwitterOutputModeOption

java.lang.Object

java.lang.Enum<TwitterOutputModeOption>

org.openimaj.tools.twitter.modes.output.TwitterOutputModeOption

All Implemented Interfaces:

Serializable, Comparable<TwitterOutputModeOption>, CmdLineOptionsProvider

public enum TwitterOutputModeOption
extends Enum<TwitterOutputModeOption>
implements CmdLineOptionsProvider

Control how twitter analysis should be outputted

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANALYSIS just the analysis, no tweet
APPEND Appends the analysis to tweets
CONDENSED analysis and JPATH specified optional extras

Method Summary

Modifier and Type	Method and Description
abstract TwitterOutputMode	getOptions()
static TwitterOutputModeOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static TwitterOutputModeOption[]	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

APPEND

public static final TwitterOutputModeOption APPEND

Appends the analysis to tweets

CONDENSED

public static final TwitterOutputModeOption CONDENSED

analysis and JPATH specified optional extras

ANALYSIS

public static final TwitterOutputModeOption ANALYSIS

just the analysis, no tweet

Method Detail

values

public static TwitterOutputModeOption[] 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 (TwitterOutputModeOption c : TwitterOutputModeOption.values())
    System.out.println(c);

Returns:

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

valueOf

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

getOptions

public abstract TwitterOutputMode getOptions()

Specified by:

getOptions in interface CmdLineOptionsProvider

Returns:

the object providing options/arguments