|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sun.jimi.core.options.FormatOption
Class representing an option for a format. Options include such things as compression scheme, use of interlacing, or any other parameter that a file format makes use of.
Field Summary | |
protected java.lang.Object |
defaultValue
|
protected java.lang.String |
description
|
protected java.lang.String |
name
|
protected java.lang.Object |
possibleValues
|
protected java.lang.Object |
value
|
Constructor Summary | |
FormatOption(java.lang.String name,
java.lang.String description,
java.lang.Object possibleValues,
java.lang.Object defaultValue)
Create a FormatOption object. |
Method Summary | |
java.lang.Object |
clone()
Shallow-copy clone from java.lang.Object. |
java.lang.Object |
getDefaultValue()
Get the default value of the option |
java.lang.String |
getDescription()
Get a string describing the option. |
java.lang.String |
getName()
Get the name of the option. |
java.lang.Object |
getPossibleValues()
Get a set of objects describing the legal values of the option. |
java.lang.Object |
getValue()
Get the current value of the option. |
void |
parseValue(java.lang.String value)
Interpret the value of the option from a String. |
void |
setValue(java.lang.Object value)
Set the value of the option. |
Methods inherited from class java.lang.Object |
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
protected java.lang.String name
protected java.lang.String description
protected java.lang.Object value
protected java.lang.Object possibleValues
protected java.lang.Object defaultValue
Constructor Detail |
public FormatOption(java.lang.String name, java.lang.String description, java.lang.Object possibleValues, java.lang.Object defaultValue)
name
- the name of the optiondescription
- a description of the itempossibleValues
- an array of possible values for the optiondefaultValue
- the default value of the optionMethod Detail |
public java.lang.String getName()
public java.lang.String getDescription()
public java.lang.Object getPossibleValues()
public java.lang.Object getValue()
public void setValue(java.lang.Object value) throws OptionException
public void parseValue(java.lang.String value) throws OptionException
public java.lang.Object getDefaultValue()
public java.lang.Object clone()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |