org.checkerframework.framework.test

Class SimpleOptionMap

java.lang.Object

org.checkerframework.framework.test.SimpleOptionMap

public class SimpleOptionMap
extends Object

SimpleOptionMap is a very basic Option container. The keys of the Option container are the set of Options and the values are the arguments to those options if they exists: e.g.,

 Map(
    "-AprintAllQualifiers" => null
    "-classpath" => "myDir1:myDir2"
 )
 

This class is mainly used by TestConfigurationBuilder to make working with existing options simpler and less error prone. It is not intended for a general Option container because users creating tests via source code can more easily manipulate the map whereas a lot of sugar would be needed to make this class usable from the command line.

Constructor Summary

Constructors

Constructor and Description
SimpleOptionMap()

Method Summary

Modifier and Type	Method and Description
void	addOption(String option) Adds an option that takes no argument.
void	addOption(String option, String value) Adds an option that takes an argument.
void	addOptionIfValueNonEmpty(String option, String value) Adds the option only if value is a non-null, non-empty String.
void	addOptions(Iterable<String> newOptions)
void	addOptions(Map<String,String> options) Adds all of the options in the given map to this one.
void	addToPathOption(String key, String toAppend) A method to easily add Strings to an option that takes a filepath as an argument.
Map<String,String>	getOptions() Returns the map that backs this SimpleOptionMap.
List<String>	getOptionsAsList() Creates a "flat" list representation of these options.
void	setOptions(Map<String,String> options) Clears the current set of options and copies the input options to this map.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleOptionMap

public SimpleOptionMap()

Method Detail

setOptions

public void setOptions(Map<String,String> options)

Clears the current set of options and copies the input options to this map.

Parameters:

options - the new options to use for this object

addToPathOption

public void addToPathOption(String key,
                            String toAppend)

A method to easily add Strings to an option that takes a filepath as an argument.

Parameters:

key - an option with an argument of the form "arg1[path-separator]arg2..." e.g., "-cp myDir:myDir2:myDir3"

toAppend - a string to append onto the path or, if the path is null/empty, the argument to the option indicated by key

addOption

public void addOption(String option)

Adds an option that takes no argument.

Parameters:

option - the no-argument option to add to this object

addOption

public void addOption(String option,
                      String value)

Adds an option that takes an argument.

Parameters:

option - the option to add to this object

value - the argument to the option

addOptionIfValueNonEmpty

public void addOptionIfValueNonEmpty(String option,
                                     String value)

Adds the option only if value is a non-null, non-empty String.

Parameters:

option - the option to add to this object

value - the argument to the option (or null)

addOptions

public void addOptions(Map<String,String> options)

Adds all of the options in the given map to this one.

Parameters:

options - the options to add to this object

addOptions

public void addOptions(Iterable<String> newOptions)

getOptions

public Map<String,String> getOptions()

Returns the map that backs this SimpleOptionMap.

Returns:

the options in this object

getOptionsAsList

public List<String> getOptionsAsList()

Creates a "flat" list representation of these options.

Returns:

a list of the string representations of the options in this object