Removed DOCUMENT ME comments that were generated and applied source code
[utils] / support / spring / src / main / java / org / wamblee / concurrency / spring / LockAdvice.java
1 /*
2  * Copyright 2005 the original author or authors.
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 package org.wamblee.concurrency.spring;
17
18 import org.aopalliance.intercept.MethodInterceptor;
19 import org.aopalliance.intercept.MethodInvocation;
20
21 import org.wamblee.concurrency.Lock;
22
23 /**
24  * Locking advice. This automatically synchronized an object using a given lock.
25  * 
26  * @author Erik Brakkee
27  */
28 public class LockAdvice implements MethodInterceptor {
29     /**
30      * Lock to use.
31      */
32     private Lock lock;
33
34     /**
35      * Constructs lock advice.
36      * 
37      * @param aLock
38      *            Lock to use.
39      */
40     public LockAdvice(Lock aLock) {
41         lock = aLock;
42     }
43
44     /*
45      * (non-Javadoc)
46      * 
47      * @see
48      * org.aopalliance.intercept.MethodInterceptor#invoke(org.aopalliance.intercept
49      * .MethodInvocation)
50      */
51     public Object invoke(MethodInvocation aInvocation) throws Throwable {
52         lock.acquire();
53
54         try {
55             return aInvocation.proceed();
56         } finally {
57             lock.release();
58         }
59     }
60 }