Package de.gebit.integrity.fixtures

Interface CustomProposalProvider

public interface CustomProposalProvider

Implementations of this interface are used by Integrity inside Eclipse to determine proposals for parameter values. Link implementations to their respective fixture classes by means of CustomProposalProvider.CustomProposalFixtureLink.

Author:

Rene Schneider - initial API and implementation

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CustomProposalProvider.CustomProposalDefinition	A container for the definition of one proposal.
static interface	CustomProposalProvider.CustomProposalFixtureLink	This annotation is used to link a CustomProposalProvider to an implementation of CustomProposalFixture, for which it will provide the parameter value proposals.

Method Summary

Modifier and Type	Method	Description
List<CustomProposalProvider.CustomProposalDefinition>	defineParameterProposals(String aFixtureMethodName, String aParameterName, Map<String,Object> someParameterValues)	Returns a list of proposals to be offered to the user for a given fixture method and parameter name.
List<CustomProposalProvider.CustomProposalDefinition>	defineResultProposals(String aFixtureMethodName, String aResultName, Object aResultValue, Map<String,Object> someParameterValues)	Returns a list of proposals to be offered to the user for a given fixture method and result name.

Method Detail

defineParameterProposals

List<CustomProposalProvider.CustomProposalDefinition> defineParameterProposals(String aFixtureMethodName,
                                                                               String aParameterName,
                                                                               Map<String,Object> someParameterValues)

Returns a list of proposals to be offered to the user for a given fixture method and parameter name.

Parameters:

aFixtureMethodName - the name of the fixture method that is being used

aParameterName - the parameter for which the user has requested proposals

someParameterValues - all known parameter values (this includes already defined params as well as any - potentially incomplete - information already entered for the currently edited parameter, if available)

Returns:

defineResultProposals

List<CustomProposalProvider.CustomProposalDefinition> defineResultProposals(String aFixtureMethodName,
                                                                            String aResultName,
                                                                            Object aResultValue,
                                                                            Map<String,Object> someParameterValues)

Returns a list of proposals to be offered to the user for a given fixture method and result name.

Parameters:

aFixtureMethodName - the name of the fixture method that is being used

aResultName - the result for which the user has requested proposals (may be null if the default result is meant)

aResultValue - the (partially typed) result value, or null if the user hasn't yet entered anything

someParameterValues - all known parameter values

Returns: