1 /*
2 * Copyright (c) 2001-2017, Zoltan Farkas All Rights Reserved.
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 *
18 * Additionally licensed with:
19 *
20 * Licensed under the Apache License, Version 2.0 (the "License");
21 * you may not use this file except in compliance with the License.
22 * You may obtain a copy of the License at
23 *
24 * http://www.apache.org/licenses/LICENSE-2.0
25 *
26 * Unless required by applicable law or agreed to in writing, software
27 * distributed under the License is distributed on an "AS IS" BASIS,
28 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
29 * See the License for the specific language governing permissions and
30 * limitations under the License.
31 */
32 package org.spf4j.recyclable;
33
34 import java.util.concurrent.TimeoutException;
35 import javax.annotation.Nonnull;
36
37 /**
38 *
39 * @author Zoltan Farkas
40 */
41 public interface NonValidatingRecyclingSupplier<T> {
42
43 /**
44 * block until a object is available and return it.
45 *
46 * @return - a object instance returned by this supplier.
47 * @throws ObjectCreationException - cannot create an object.
48 * @throws ObjectBorrowException - cannot borrow an object.
49 * @throws InterruptedException - interrupted.
50 * @throws TimeoutException - timed out while getting object.
51 */
52 @Nonnull
53 T get() throws ObjectCreationException, ObjectBorrowException,
54 InterruptedException, TimeoutException;
55
56 /**
57 * recycle object.
58 * @param object - object to recycle.
59 */
60 void recycle(T object);
61
62
63 }