This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-pool.git
commit 0a0c8029b2124bffadbb3458dab5110699d23f3f Author: Gary Gregory <[email protected]> AuthorDate: Sun Mar 19 15:48:55 2023 -0400 Javadoc: Convert package.html to package-info.java --- .../org/apache/commons/pool2/package-info.java | 43 +++++++++++++++ .../java/org/apache/commons/pool2/package.html | 62 ---------------------- 2 files changed, 43 insertions(+), 62 deletions(-) diff --git a/src/main/java/org/apache/commons/pool2/package-info.java b/src/main/java/org/apache/commons/pool2/package-info.java new file mode 100644 index 00000000..3a48b23f --- /dev/null +++ b/src/main/java/org/apache/commons/pool2/package-info.java @@ -0,0 +1,43 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Object pooling API. + * <p> + * The <code>org.apache.commons.pool2</code> package defines a simple interface for a pool of object instances, and a handful of base classes that may be useful + * when creating pool implementations. + * </p> + * <p> + * The <code>pool</code> package itself doesn't define a specific object pooling implementation, but rather a contract that implementations may support in order + * to be fully interchangeable. + * </p> + * <p> + * The <code>pool</code> package separates the way in which instances are pooled from the way in which they are created, resulting in a pair of interfaces: + * </p> + * <dl> + * <dt>{@link org.apache.commons.pool2.ObjectPool ObjectPool}</dt> + * <dd>defines a simple object pooling interface, with methods for borrowing instances from and returning them to the pool.</dd> + * <dt>{@link org.apache.commons.pool2.PooledObjectFactory PooledObjectFactory}</dt> + * <dd>defines lifecycle methods for object instances contained within a pool. By associating a factory with a pool, the pool can create new object instances as + * needed.</dd> + * </dl> + * <p> + * The <code>pool</code> package also provides a keyed pool interface, which pools instances of multiple types, accessed according to an arbitrary key. See + * {@link org.apache.commons.pool2.KeyedObjectPool KeyedObjectPool} and {@link org.apache.commons.pool2.KeyedPooledObjectFactory KeyedPooledObjectFactory}. + * </p> + */ +package org.apache.commons.pool2; diff --git a/src/main/java/org/apache/commons/pool2/package.html b/src/main/java/org/apache/commons/pool2/package.html deleted file mode 100644 index 915f6022..00000000 --- a/src/main/java/org/apache/commons/pool2/package.html +++ /dev/null @@ -1,62 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<html> - <head> - <title>Package Documentation for org.apache.commons.pool2</title> - </head> - <body> - <p> - Object pooling API. - </p> - <p> - The <code>org.apache.commons.pool2</code> package defines a simple - interface for a pool of object instances, and a handful of base - classes that may be useful when creating pool implementations. - </p> - <p> - The <code>pool</code> package itself doesn't define a specific object - pooling implementation, but rather a contract that implementations may - support in order to be fully interchangeable. - </p> - <p> - The <code>pool</code> package separates the way in which instances are - pooled from the way in which they are created, resulting in a pair of - interfaces: - </p> - <dl> - <dt>{@link org.apache.commons.pool2.ObjectPool ObjectPool}</dt> - <dd> - defines a simple object pooling interface, with methods for - borrowing instances from and returning them to the pool. - </dd> - <dt>{@link org.apache.commons.pool2.PooledObjectFactory PooledObjectFactory}</dt> - <dd> - defines lifecycle methods for object instances contained within a pool. - By associating a factory with a pool, the pool can create new object - instances as needed. - </dd> - </dl> - <p> - The <code>pool</code> package also provides a keyed pool interface, - which pools instances of multiple types, accessed according to an - arbitrary key. See - {@link org.apache.commons.pool2.KeyedObjectPool KeyedObjectPool} and - {@link org.apache.commons.pool2.KeyedPooledObjectFactory - KeyedPooledObjectFactory}. - </p> - </body> -</html>
