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 ofCustomProposalProvider.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 aCustomProposalProvider
to an implementation ofCustomProposalFixture
, for which it will provide the parameter value proposals.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<CustomProposalProvider.CustomProposalDefinition>
defineParameterProposals(java.lang.String aFixtureMethodName, java.lang.String aParameterName, java.util.Map<java.lang.String,java.lang.Object> someParameterValues)
Returns a list of proposals to be offered to the user for a given fixture method and parameter name.java.util.List<CustomProposalProvider.CustomProposalDefinition>
defineResultProposals(java.lang.String aFixtureMethodName, java.lang.String aResultName, java.lang.Object aResultValue, java.util.Map<java.lang.String,java.lang.Object> someParameterValues)
Returns a list of proposals to be offered to the user for a given fixture method and result name.
-
-
-
Method Detail
-
defineParameterProposals
java.util.List<CustomProposalProvider.CustomProposalDefinition> defineParameterProposals(java.lang.String aFixtureMethodName, java.lang.String aParameterName, java.util.Map<java.lang.String,java.lang.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 usedaParameterName
- the parameter for which the user has requested proposalssomeParameterValues
- 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
java.util.List<CustomProposalProvider.CustomProposalDefinition> defineResultProposals(java.lang.String aFixtureMethodName, java.lang.String aResultName, java.lang.Object aResultValue, java.util.Map<java.lang.String,java.lang.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 usedaResultName
- 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 anythingsomeParameterValues
- all known parameter values- Returns:
-
-