1 //
2 // ========================================================================
3 // Copyright (c) 1995-2015 Mort Bay Consulting Pty. Ltd.
4 // ------------------------------------------------------------------------
5 // All rights reserved. This program and the accompanying materials
6 // are made available under the terms of the Eclipse Public License v1.0
7 // and Apache License v2.0 which accompanies this distribution.
8 //
9 // The Eclipse Public License is available at
10 // http://www.eclipse.org/legal/epl-v10.html
11 //
12 // The Apache License v2.0 is available at
13 // http://www.opensource.org/licenses/apache2.0.php
14 //
15 // You may elect to redistribute this code under either of these licenses.
16 // ========================================================================
17 //
18
19 package org.eclipse.jetty.client;
20
21 /**
22 * <p>Implementations of this interface expose a lock object
23 * via {@link #getLock()} so that callers can synchronize
24 * externally on that lock:</p>
25 * <pre>
26 * if (iterator instanceof Synchronizable)
27 * {
28 * Object element = null;
29 * synchronized (((Synchronizable)iterator).getLock())
30 * {
31 * if (iterator.hasNext())
32 * element = iterator.next();
33 * }
34 * }
35 * </pre>
36 * <p>In the example above, the calls to {@code hasNext()} and
37 * {@code next()} are performed "atomically".</p>
38 */
39 public interface Synchronizable
40 {
41 /**
42 * @return the lock object to synchronize on
43 */
44 public Object getLock();
45 }