1 /*
2 * Copyright (C) 2010 Atlassian
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package com.atlassian.jira.rest.client;
18
19 /**
20 * All remote operations take a parameter of this interface.<br>
21 * Firstly it serves as a clear marker of a remote call.
22 * Secondly, in the future, we plan to actually make this interface capable of reporting the progress
23 * and cancelling (where possible) remote requests taking too much time.
24 *
25 * So while you may blame this class for the time being, the plan is that it will actually be beneficial
26 * one day without any need to break API compatibility.
27 *
28 * @since v0.1
29 */
30 public interface ProgressMonitor {
31 }