1 package org.eclipse.aether.named;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 /**
23 * A factory of {@link NamedLock}s.
24 */
25 public interface NamedLockFactory
26 {
27 /**
28 * Creates or reuses existing {@link NamedLock}. Returns instance MUST BE treated as "resource", best in
29 * try-with-resource block.
30 *
31 * @param name the lock name, must not be {@code null}.
32 * @return named lock instance, never {@code null}.
33 */
34 NamedLock getLock( String name );
35
36 /**
37 * Performs a clean shut down of the factory.
38 */
39 void shutdown();
40 }