org.openscience.cdk.io.setting

Class OptionIOSetting

java.lang.Object

org.openscience.cdk.io.setting.IOSetting

org.openscience.cdk.io.setting.OptionIOSetting

All Implemented Interfaces:

ISetting

public class OptionIOSetting
extends IOSetting

An class for a reader setting which must be found in the list of possible settings.

Author:

Egon Willighagen <egonw@sci.kun.nl>

Source code:

master

Belongs to CDK module:

io

Nested Class Summary

Nested classes/interfaces inherited from class org.openscience.cdk.io.setting.IOSetting

IOSetting.Importance

Field Summary

Fields inherited from class org.openscience.cdk.io.setting.IOSetting

level, name, question, setting

Constructor Summary

Constructors

Constructor and Description
OptionIOSetting(String name, IOSetting.Importance level, String question, List<String> settings, String defaultSetting) OptionIOSetting is IOSetting for which the value must be in the list of possible options.

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getOptions() Returns a Vector of Strings containing all possible options.
void	setSetting(int setting) Sets the setting for a certain question.
void	setSetting(String setting) Sets the setting for a certain question.

Methods inherited from class org.openscience.cdk.io.setting.IOSetting

getDefaultSetting, getLevel, getName, getQuestion, getSetting

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionIOSetting

public OptionIOSetting(String name,
               IOSetting.Importance level,
               String question,
               List<String> settings,
               String defaultSetting)

OptionIOSetting is IOSetting for which the value must be in the list of possible options.

Method Detail

setSetting

public void setSetting(String setting)
                throws CDKException

Sets the setting for a certain question. It will throw a CDKException when the setting is not valid.

Overrides:

setSetting in class IOSetting

Throws:

CDKException

setSetting

public void setSetting(int setting)
                throws CDKException

Sets the setting for a certain question. It will throw a CDKException when the setting is not valid. The first setting is setting 1.

Throws:

CDKException

getOptions

public List<String> getOptions()

Returns a Vector of Strings containing all possible options.