com.sun.jimi.core.options
Interface FormatOptionSet

All Known Implementing Classes:
BasicFormatOptionSet

public abstract interface FormatOptionSet
extends java.lang.Cloneable

Interface representing a set of options for a format, and methods to dynamically discover them. All JimiImages have FormatOptionSets associated with them which detail any properties associated with them, and FormatOptionSets can be used with JimiWriters to specify special properties for image encoding.

FormatOptionSet has subclasses for certain formats, which provide a Java-class interface to options manipulation.

See Also:
GIFOptions, PNGOptions, SunRasterOptions

Method Summary
 void copyOptionsFrom(FormatOptionSet source)
          Copy all relevant values from another FormatOptionSet.
 FormatOption getOption(java.lang.String name)
          Get an option from the set by name.
 FormatOption[] getOptions()
          Get the options in the set.
 

Method Detail

getOptions

public FormatOption[] getOptions()
Get the options in the set.

getOption

public FormatOption getOption(java.lang.String name)
                       throws OptionException
Get an option from the set by name.

copyOptionsFrom

public void copyOptionsFrom(FormatOptionSet source)
Copy all relevant values from another FormatOptionSet.