1e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson/*
2e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson * Copyright (c) 2007 Mockito contributors
3e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson * This program is made available under the terms of the MIT License.
4e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson */
5e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinsonpackage org.mockito.invocation;
6e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson
7e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinsonimport org.mockito.exceptions.PrintableInvocation;
8e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinsonimport org.mockito.Incubating;
9e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson
10e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson/**
11e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson * Provides information about the invocation, specifically a human readable description and the location.
12e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson */
13e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson@Incubating
14e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinsonpublic interface DescribedInvocation extends PrintableInvocation {
15e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson
16e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson    /**
17e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson     * Describes the invocation in the human friendly way.
18e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson     *
19e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson     * @return the description of this invocation.
20e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson     */
21e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson    String toString();
22e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson
23e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson    /**
24e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson     * The place in the code where the invocation happened.
25e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson     *
26e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson     * @return the location of the invocation.
27e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson     */
28e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson    Location getLocation();
29e0ae5d7e87b1dd6e789803c1b9615a84bd7488b7Ian Parkinson}
30