Skip navigation links

com.oracle.outsidein.options
Interface Option

All Known Subinterfaces:

OptionImpl

All Known Implementing Classes:

Options

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.

See Also:

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

getName

java.lang.String getName()

Obtains the unique name of this option.

Returns:

the option name as a String

getDescription

java.lang.String getDescription()

Obtains a brief, human readable description of this option.

Returns:

the option description as a String

getDataType

java.lang.Class<?> getDataType()

Gets the type of data that an option takes. If the returned type is a generic, then getItemTypes() should be called to retrieve its type parameters.

Returns:

the type of the option data

getItemTypes

java.lang.Class<?>[] getItemTypes()

Gets the type parameters for option values that are generics.

Returns:

the type parameters for generic values returned by getDataType(), or null if that type is not a generic.

getSupportingProducts

java.util.EnumSet<Option.OutsideInProducts> getSupportingProducts()

Gets the set of products that support this option

Returns:

the products that support this option

set

void set(OptionsCache exporter,
         java.lang.Object objValue)
         throws OutsideInException

Sets an option value and checks the value type at runtime instead of compile-time. The type should be compatible with the type returned by getDataType(). This method may be used in place of the OptionCache.set[OptionName] methods that provide compile-time type checking of option values.

Parameters:

exporter - the exporter that contains the option to set

objValue - the new option value

Throws:

OutsideInException - If the value cannot be converted to the type expected by the specific option.

get

java.lang.Object get(OptionsCache exporter)
                     throws OutsideInException

Gets the current option value from the specified Exporter object.

Parameters:

exporter - the exporter that contains the option value requested

Returns:

the option value as an opaque Object that can be cast using getDataType()

Throws:

OutsideInException

Skip navigation links