You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/03/19 19:49:07 UTC
[commons-pool] branch master updated (392685c3 -> 0a0c8029)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-pool.git
from 392685c3 Bump actions/checkout from 3.3.0 to 3.4.0 (#216)
new c9a98c04 Javadoc: Convert package.html to package-info.java
new 2073350a Javadoc: Convert package.html to package-info.java
new 0a0c8029 Javadoc: Convert package.html to package-info.java
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../apache/commons/pool2/impl/package-info.java} | 37 +++++--------
.../org/apache/commons/pool2/impl/package.html | 41 --------------
.../org/apache/commons/pool2/package-info.java | 43 +++++++++++++++
.../java/org/apache/commons/pool2/package.html | 62 ----------------------
.../apache/commons/pool2/proxy/package-info.java} | 24 +++++----
.../org/apache/commons/pool2/proxy/package.html | 37 -------------
6 files changed, 72 insertions(+), 172 deletions(-)
copy src/{test/java/org/apache/commons/pool2/impl/TestConstants.java => main/java/org/apache/commons/pool2/impl/package-info.java} (54%)
delete mode 100644 src/main/java/org/apache/commons/pool2/impl/package.html
create mode 100644 src/main/java/org/apache/commons/pool2/package-info.java
delete mode 100644 src/main/java/org/apache/commons/pool2/package.html
copy src/{test/java/org/apache/commons/pool2/proxy/TestProxiedKeyedObjectPoolWithCglibProxy.java => main/java/org/apache/commons/pool2/proxy/package-info.java} (59%)
delete mode 100644 src/main/java/org/apache/commons/pool2/proxy/package.html
[commons-pool] 01/03: Javadoc: Convert package.html to package-info.java
Posted by gg...@apache.org.
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 c9a98c04e19d75f8383c63f167d4b9d01c22824c
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Mar 19 15:48:40 2023 -0400
Javadoc: Convert package.html to package-info.java
---
.../apache/commons/pool2/impl/package-info.java | 33 +++++++++++++++++
.../org/apache/commons/pool2/impl/package.html | 41 ----------------------
2 files changed, 33 insertions(+), 41 deletions(-)
diff --git a/src/main/java/org/apache/commons/pool2/impl/package-info.java b/src/main/java/org/apache/commons/pool2/impl/package-info.java
new file mode 100644
index 00000000..7bbd4566
--- /dev/null
+++ b/src/main/java/org/apache/commons/pool2/impl/package-info.java
@@ -0,0 +1,33 @@
+/*
+ * 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 implementations.
+ * <p>
+ * {@link org.apache.commons.pool2.impl.GenericObjectPool GenericObjectPool} ({@link org.apache.commons.pool2.impl.GenericKeyedObjectPool
+ * GenericKeyedObjectPool}) provides a more robust (but also more complicated) implementation of {@link org.apache.commons.pool2.ObjectPool ObjectPool}
+ * ({@link org.apache.commons.pool2.KeyedObjectPool KeyedObjectPool}).
+ * </p>
+ * <p>
+ * {@link org.apache.commons.pool2.impl.SoftReferenceObjectPool SoftReferenceObjectPool} provides a {@link java.lang.ref.SoftReference SoftReference} based
+ * {@link org.apache.commons.pool2.ObjectPool ObjectPool}.
+ * </p>
+ * <p>
+ * See also the {@link org.apache.commons.pool2} package.
+ * </p>
+ */
+package org.apache.commons.pool2.impl;
diff --git a/src/main/java/org/apache/commons/pool2/impl/package.html b/src/main/java/org/apache/commons/pool2/impl/package.html
deleted file mode 100644
index 5666f6cd..00000000
--- a/src/main/java/org/apache/commons/pool2/impl/package.html
+++ /dev/null
@@ -1,41 +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.impl</title>
- </head>
- <body>
- <p>
- Object pooling API implementations.
- </p>
- <p>
- {@link org.apache.commons.pool2.impl.GenericObjectPool GenericObjectPool}
- ({@link org.apache.commons.pool2.impl.GenericKeyedObjectPool GenericKeyedObjectPool})
- provides a more robust (but also more complicated)
- implementation of {@link org.apache.commons.pool2.ObjectPool ObjectPool}
- ({@link org.apache.commons.pool2.KeyedObjectPool KeyedObjectPool}).
- </p>
- <p>
- {@link org.apache.commons.pool2.impl.SoftReferenceObjectPool SoftReferenceObjectPool}
- provides a {@link java.lang.ref.SoftReference SoftReference} based
- {@link org.apache.commons.pool2.ObjectPool ObjectPool}.
- </p>
- <p>
- See also the {@link org.apache.commons.pool2} package.
- </p>
- </body>
-</html>
[commons-pool] 03/03: Javadoc: Convert package.html to package-info.java
Posted by gg...@apache.org.
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 <ga...@gmail.com>
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>
[commons-pool] 02/03: Javadoc: Convert package.html to package-info.java
Posted by gg...@apache.org.
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 2073350aefedb7593619e6455e9bde16a94e6920
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Mar 19 15:48:46 2023 -0400
Javadoc: Convert package.html to package-info.java
---
.../apache/commons/pool2/proxy/package-info.java | 32 +++++++++++++++++++
.../org/apache/commons/pool2/proxy/package.html | 37 ----------------------
2 files changed, 32 insertions(+), 37 deletions(-)
diff --git a/src/main/java/org/apache/commons/pool2/proxy/package-info.java b/src/main/java/org/apache/commons/pool2/proxy/package-info.java
new file mode 100644
index 00000000..75cfdc1b
--- /dev/null
+++ b/src/main/java/org/apache/commons/pool2/proxy/package-info.java
@@ -0,0 +1,32 @@
+/*
+ * 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 proxy implementation.
+ * <p>
+ * The <code>org.apache.commons.pool2.proxy</code> package defines a
+ * object pool that wraps all objects returned to clients. This allows it
+ * to disable those proxies when the objects are returned thereby enabling
+ * the continued use of those objects by clients to be detected..
+ * </p>
+ * <p>
+ * Support is provided for <code>java.lang.reflect.Proxy</code> and for
+ * <code>net.sf.cglib.proxy</code> based proxies. The latter, requires the
+ * additional of the optional Code Generation Library (GCLib).
+ * </p>
+ */
+package org.apache.commons.pool2.proxy;
diff --git a/src/main/java/org/apache/commons/pool2/proxy/package.html b/src/main/java/org/apache/commons/pool2/proxy/package.html
deleted file mode 100644
index 5e4fbae0..00000000
--- a/src/main/java/org/apache/commons/pool2/proxy/package.html
+++ /dev/null
@@ -1,37 +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.proxy</title>
- </head>
- <body>
- <p>
- Object pooling proxy implementation.
- </p>
- <p>
- The <code>org.apache.commons.pool2.proxy</code> package defines a
- object pool that wraps all objects returned to clients. This allows it
- to disable those proxies when the objects are returned thereby enabling
- the continued use of those objects by clients to be detected..
- </p>
- <p>
- Support is provided for <code>java.lang.reflect.Proxy</code> and for
- <code>net.sf.cglib.proxy</code> based proxies. The latter, requires the
- additional of the optional Code Generation Library (GCLib).
- </p>
- </body>
-</html>