edu.stanford.nlp.util

Class Execution

java.lang.Object

edu.stanford.nlp.util.Execution

public class Execution
extends Object

A class to set command line options. To use, create a static class into which you'd like to put your properties. Then, for each field, set the annotation:

   
     import edu.stanford.nlp.util.Execution.Option

     class Props {
       @Option(name="anIntOption", required=false)
       public static int anIntOption = 7 // default value is 7
       @Option(name="anotherOption", required=false)
       public static File aCastableOption = new File("/foo")
     }
   
 

You can then set options with exec(Runnable, String[]), or with fillOptions(java.util.Properties).

If your default classpath has many classes in it, you can select a subset of them by using fillOptions(Class[], java.util.Properties), or some variant.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Execution.LazyFileIterator A lazy iterator over files, not loading all of them into memory at once.
static interface	Execution.Option

Field Summary

Fields

Modifier and Type	Field and Description
static String	host
static Class<?>[]	optionClasses
static int	threads

Constructor Summary

Constructors

Constructor and Description
Execution()

Method Summary

Modifier and Type	Method and Description
static void	exec(Runnable toRun)
static void	exec(Runnable toRun, Class[] optionClasses)
static void	exec(Runnable toRun, Properties options)
static void	exec(Runnable toRun, Properties options, boolean exit)
static void	exec(Runnable toRun, String[] args)
static void	exec(Runnable toRun, String[] args, boolean exit)
static void	exec(Runnable toRun, String[] args, Class[] optionClasses)
static void	exec(Runnable toRun, String[] args, Class[] optionClasses, boolean exit)
static void	fillOptions(Class<?>[] classes, Properties options)
static void	fillOptions(Class<?>[] optionClasses, Properties props, String[] args)
static void	fillOptions(Class<?>[] classes, String[] args)
static void	fillOptions(Class<?> clazz, Properties options)
static void	fillOptions(Class<?> clazz, String[] args)
static void	fillOptions(Object[] instances, Properties options)
static void	fillOptions(Object[] instances, String[] args)
static void	fillOptions(Object instance, Properties options)
static void	fillOptions(Object instance, String[] args)
static void	fillOptions(Properties props)
static void	fillOptions(Properties props, String[] args)
protected static Map<String,Field>	fillOptionsImpl(Object[] instances, Class<?>[] classes, Properties options)
protected static Map<String,Field>	fillOptionsImpl(Object[] instances, Class<?>[] classes, Properties options, boolean ensureAllOptions)
static Class<?>[]	getVisibleClasses()
static void	usageAndExit(Map<String,String[]> argToFlagsMap)
static void	usageAndExit(String[] expectedArgs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

optionClasses

@Execution.Option(name="option_classes",
                  gloss="Fill options from these classes")
public static Class<?>[] optionClasses

threads

@Execution.Option(name="threads",
                  gloss="Number of threads on machine")
public static int threads

host

@Execution.Option(name="host",
                  gloss="Name of computer we are running on")
public static String host

Constructor Detail

Execution

public Execution()

Method Detail

getVisibleClasses

public static Class<?>[] getVisibleClasses()

fillOptionsImpl

protected static Map<String,Field> fillOptionsImpl(Object[] instances,
                                                   Class<?>[] classes,
                                                   Properties options,
                                                   boolean ensureAllOptions)

fillOptionsImpl

protected static Map<String,Field> fillOptionsImpl(Object[] instances,
                                                   Class<?>[] classes,
                                                   Properties options)

fillOptions

public static void fillOptions(Class<?>[] classes,
                               Properties options)

fillOptions

public static void fillOptions(Class<?> clazz,
                               Properties options)

fillOptions

public static void fillOptions(Properties props,
                               String[] args)

fillOptions

public static void fillOptions(Class<?>[] optionClasses,
                               Properties props,
                               String[] args)

fillOptions

public static void fillOptions(Properties props)

fillOptions

public static void fillOptions(Class<?>[] classes,
                               String[] args)

fillOptions

public static void fillOptions(Class<?> clazz,
                               String[] args)

fillOptions

public static void fillOptions(Object[] instances,
                               Properties options)

fillOptions

public static void fillOptions(Object instance,
                               Properties options)

fillOptions

public static void fillOptions(Object[] instances,
                               String[] args)

fillOptions

public static void fillOptions(Object instance,
                               String[] args)

exec

public static void exec(Runnable toRun)

exec

public static void exec(Runnable toRun,
                        Class[] optionClasses)

exec

public static void exec(Runnable toRun,
                        String[] args)

exec

public static void exec(Runnable toRun,
                        String[] args,
                        Class[] optionClasses)

exec

public static void exec(Runnable toRun,
                        String[] args,
                        Class[] optionClasses,
                        boolean exit)

exec

public static void exec(Runnable toRun,
                        String[] args,
                        boolean exit)

exec

public static void exec(Runnable toRun,
                        Properties options)

exec

public static void exec(Runnable toRun,
                        Properties options,
                        boolean exit)

usageAndExit

public static void usageAndExit(String[] expectedArgs)

usageAndExit

public static void usageAndExit(Map<String,String[]> argToFlagsMap)