|
Oracle Outside In Java API Reference 8.5.4 E91699-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Option
Interface for exposing an export option by name and providing a brief description of the option. Values in the Options
enumeration implement this interface.
Options
Nested Class Summary | |
---|---|
static class |
Option.OutsideInProducts List of Outside In export products |
Method Summary | |
---|---|
java.lang.Object |
get(OptionsCache exporter) Gets the current option value from the specified Exporter object. |
java.lang.Class<?> |
getDataType() Gets the type of data that an option takes. |
java.lang.String |
getDescription() Obtains a brief, human readable description of this option. |
java.lang.Class<?>[] |
getItemTypes() Gets the type parameters for option values that are generics. |
java.lang.String |
getName() Obtains the unique name of this option. |
java.util.EnumSet<Option.OutsideInProducts> |
getSupportingProducts() Gets the set of products that support this option |
void |
set(OptionsCache exporter, java.lang.Object objValue) Sets an option value and checks the value type at runtime instead of compile-time. |
Method Detail |
---|
java.lang.String getName()
String
java.lang.String getDescription()
String
java.lang.Class<?> getDataType()
getItemTypes()
should be called to retrieve its type parameters.java.lang.Class<?>[] getItemTypes()
getDataType()
, or null
if that type is not a generic.java.util.EnumSet<Option.OutsideInProducts> getSupportingProducts()
void set(OptionsCache exporter, java.lang.Object objValue) throws OutsideInException
getDataType()
. This method may be used in place of the OptionCache.set[OptionName] methods that provide compile-time type checking of option values.exporter
- the exporter that contains the option to setobjValue
- the new option valueOutsideInException
- If the value cannot be converted to the type expected by the specific option.java.lang.Object get(OptionsCache exporter) throws OutsideInException
Exporter
object.exporter
- the exporter that contains the option value requestedgetDataType()
OutsideInException
|
Oracle Outside In Java API Reference 8.5.4 E91699-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |