1 /****************************************************************
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 ****************************************************************/
19
20 package org.apache.james.mailrepository.javamail;
21
22 /**
23 * Interface for org.apache.james.util.Lock functionality to be able to replace
24 * implementation or using Mock-objects at tests
25 *
26 * @see org.apache.james.util.Lock
27 */
28 public interface LockInterface {
29
30 /**
31 * Check to see if the object is locked
32 *
33 * @param key the Object on which to check the lock
34 * @return true if the object is locked, false otherwise
35 */
36 public boolean isLocked(final Object key);
37
38 /**
39 * Lock on a given object.
40 *
41 * @param key the Object on which to lock
42 * @return true if the locking was successful, false otherwise
43 */
44 public boolean lock(final Object key);
45
46 /**
47 * Release the lock on a given object.
48 *
49 * @param key the Object on which the lock is held
50 * @return true if the unlocking was successful, false otherwise
51 */
52 public boolean unlock(final Object key);
53
54 }