diff --git a/src/changes/changes.xml b/src/changes/changes.xml index c4dc3d50b..47b8358df 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -22,6 +22,7 @@ + Convert package.html files to package-info.java files FastDateParser does not handle two digit year parsing like SimpleDateFormat FastDateParserTest.testParses does not test FastDateParser Fix deprecation warnings diff --git a/src/main/java/org/apache/commons/lang3/builder/package-info.java b/src/main/java/org/apache/commons/lang3/builder/package-info.java new file mode 100644 index 000000000..b8c1e07da --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/builder/package-info.java @@ -0,0 +1,30 @@ +/* + * 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. + */ +/** + *

Assists in creating consistent {@code equals(Object)}, {@code toString()}, + * {@code hashCode()}, and {@code compareTo(Object)} methods.

+ *

These classes are not thread-safe.

+ * + * @see java.lang.Object#equals(Object) + * @see java.lang.Object#toString() + * @see java.lang.Object#hashCode() + * @see java.lang.Comparable#compareTo(Object) + * + * @since 1.0 + * @version $Id$ + */ +package org.apache.commons.lang3.builder; diff --git a/src/main/java/org/apache/commons/lang3/builder/package.html b/src/main/java/org/apache/commons/lang3/builder/package.html deleted file mode 100644 index dd40682d3..000000000 --- a/src/main/java/org/apache/commons/lang3/builder/package.html +++ /dev/null @@ -1,28 +0,0 @@ - - - -Assists in creating consistent equals(Object), toString(), -hashCode(), and compareTo(Object) methods. -@see java.lang.Object#equals(Object) -@see java.lang.Object#toString() -@see java.lang.Object#hashCode() -@see java.lang.Comparable#compareTo(Object) -@since 1.0 -

These classes are not thread-safe.

- - diff --git a/src/main/java/org/apache/commons/lang3/concurrent/package-info.java b/src/main/java/org/apache/commons/lang3/concurrent/package-info.java new file mode 100644 index 000000000..637e5aa2f --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/concurrent/package-info.java @@ -0,0 +1,24 @@ +/* + * 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. + */ +/** + *

Provides support classes for multi-threaded programming. This package is + * intended to be an extension to {@code java.util.concurrent}.

+ *

These classes are thread-safe.

+ * + * @version $Id$ + */ +package org.apache.commons.lang3.concurrent; diff --git a/src/main/java/org/apache/commons/lang3/concurrent/package.html b/src/main/java/org/apache/commons/lang3/concurrent/package.html deleted file mode 100644 index 0ab61e0eb..000000000 --- a/src/main/java/org/apache/commons/lang3/concurrent/package.html +++ /dev/null @@ -1,23 +0,0 @@ - - - -Provides support classes for multi-threaded programming. This package is -intended to be an extension to java.util.concurrent. -

These classes are thread-safe.

- - diff --git a/src/main/java/org/apache/commons/lang3/event/package-info.java b/src/main/java/org/apache/commons/lang3/event/package-info.java new file mode 100644 index 000000000..4b70c15b4 --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/event/package-info.java @@ -0,0 +1,23 @@ +/* + * 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. + */ +/** + * Provides some useful event-based utilities. + * + * @since 3.0 + * @version $Id$ + */ +package org.apache.commons.lang3.event; diff --git a/src/main/java/org/apache/commons/lang3/event/package.html b/src/main/java/org/apache/commons/lang3/event/package.html deleted file mode 100644 index c5d95f670..000000000 --- a/src/main/java/org/apache/commons/lang3/event/package.html +++ /dev/null @@ -1,22 +0,0 @@ - - - -Provides some useful event-based utilities. -@since 3.0 - - diff --git a/src/main/java/org/apache/commons/lang3/exception/package-info.java b/src/main/java/org/apache/commons/lang3/exception/package-info.java new file mode 100644 index 000000000..713f60877 --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/exception/package-info.java @@ -0,0 +1,27 @@ +/* + * 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. + */ +/** + *

Provides functionality for Exceptions.

+ *

Contains the concept of an exception with context i.e. such an exception will contain a map with keys and values. + * This provides an easy way to pass valuable state information at exception time in useful form to a calling process.

+ *

Lastly, {@link org.apache.commons.lang3.exception.ExceptionUtils} also contains Throwable manipulation + * and examination routines.

+ * + * @since 1.0 + * @version $Id$ + */ +package org.apache.commons.lang3.exception; diff --git a/src/main/java/org/apache/commons/lang3/exception/package.html b/src/main/java/org/apache/commons/lang3/exception/package.html deleted file mode 100644 index b9d940364..000000000 --- a/src/main/java/org/apache/commons/lang3/exception/package.html +++ /dev/null @@ -1,27 +0,0 @@ - - - -Provides functionality for Exceptions. -

Contains the concept of an exception with context i.e. such an exception -will contain a map with keys and values. This provides an easy way to pass valuable -state information at exception time in useful form to a calling process.

-

Lastly, {@link org.apache.commons.lang3.exception.ExceptionUtils} -also contains Throwable manipulation and examination routines.

-@since 1.0 - - diff --git a/src/main/java/org/apache/commons/lang3/math/package-info.java b/src/main/java/org/apache/commons/lang3/math/package-info.java new file mode 100644 index 000000000..ae2b3ad4a --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/math/package-info.java @@ -0,0 +1,26 @@ +/* + * 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. + */ +/** + *

Extends {@link java.math} for business mathematical classes. This package is intended for business + * mathematical use, not scientific use. See Commons Math + * for a more complete set of mathematical classes.

+ *

These classes are immutable, and therefore thread-safe.

+ * + * @since 2.0 + * @version $Id$ + */ +package org.apache.commons.lang3.math; diff --git a/src/main/java/org/apache/commons/lang3/math/package.html b/src/main/java/org/apache/commons/lang3/math/package.html deleted file mode 100644 index 7f6291196..000000000 --- a/src/main/java/org/apache/commons/lang3/math/package.html +++ /dev/null @@ -1,25 +0,0 @@ - - - -Extends {@link java.math} for business mathematical classes. This package is intended for business -mathematical use, not scientific use. See Commons Math -for a more complete set of mathematical classes. -@since 2.0 -

These classes are immutable, and therefore thread-safe.

- - diff --git a/src/main/java/org/apache/commons/lang3/mutable/package-info.java b/src/main/java/org/apache/commons/lang3/mutable/package-info.java new file mode 100644 index 000000000..678e99a9c --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/mutable/package-info.java @@ -0,0 +1,24 @@ +/* + * 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. + */ +/** + *

Provides typed mutable wrappers to primitive values and Object.

+ *

These classes are not thread-safe.

+ * + * @since 2.1 + * @version $Id$ + */ +package org.apache.commons.lang3.mutable; diff --git a/src/main/java/org/apache/commons/lang3/mutable/package.html b/src/main/java/org/apache/commons/lang3/mutable/package.html deleted file mode 100644 index 2f7436afd..000000000 --- a/src/main/java/org/apache/commons/lang3/mutable/package.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - -Provides typed mutable wrappers to primitive values and Object. -@since 2.1 -

These classes are not thread-safe.

- - diff --git a/src/main/java/org/apache/commons/lang3/overview.html b/src/main/java/org/apache/commons/lang3/overview.html deleted file mode 100644 index f8433aae7..000000000 --- a/src/main/java/org/apache/commons/lang3/overview.html +++ /dev/null @@ -1,23 +0,0 @@ - - - -

-This document is the API specification for the Apache Commons Lang library. -

- - diff --git a/src/main/java/org/apache/commons/lang3/package-info.java b/src/main/java/org/apache/commons/lang3/package-info.java new file mode 100644 index 000000000..c8704c1b3 --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/package-info.java @@ -0,0 +1,26 @@ +/* + * 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. + */ +/** + *

Provides highly reusable static utility methods, chiefly concerned + * with adding value to the {@link java.lang} classes.

+ *

Most of these classes are immutable and thus thread-safe. + * However Charset is not currently guaranteed thread-safe under all circumstances.

+ * + * @since 1.0 + * @version $Id$ + */ +package org.apache.commons.lang3; diff --git a/src/main/java/org/apache/commons/lang3/package.html b/src/main/java/org/apache/commons/lang3/package.html deleted file mode 100644 index 1625c62dd..000000000 --- a/src/main/java/org/apache/commons/lang3/package.html +++ /dev/null @@ -1,25 +0,0 @@ - - - -Provides highly reusable static utility methods, chiefly concerned -with adding value to the {@link java.lang} classes. -@since 1.0 -

Most of these classes are immutable and thus thread-safe. -However Charset is not currently guaranteed thread-safe under all circumstances.

- - diff --git a/src/main/java/org/apache/commons/lang3/reflect/package-info.java b/src/main/java/org/apache/commons/lang3/reflect/package-info.java new file mode 100644 index 000000000..79672acf1 --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/reflect/package-info.java @@ -0,0 +1,24 @@ +/* + * 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. + */ +/** + *

Accumulates common high-level uses of the {@code java.lang.reflect} APIs.

+ *

These classes are immutable, and therefore thread-safe.

+ * + * @since 3.0 + * @version $Id$ + */ +package org.apache.commons.lang3.reflect; diff --git a/src/main/java/org/apache/commons/lang3/reflect/package.html b/src/main/java/org/apache/commons/lang3/reflect/package.html deleted file mode 100644 index 618b07a8c..000000000 --- a/src/main/java/org/apache/commons/lang3/reflect/package.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - -Accumulates common high-level uses of the java.lang.reflect APIs. -@since 3.0 -

These classes are immutable, and therefore thread-safe.

- - diff --git a/src/main/java/org/apache/commons/lang3/text/package-info.java b/src/main/java/org/apache/commons/lang3/text/package-info.java new file mode 100644 index 000000000..1f3b44afb --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/text/package-info.java @@ -0,0 +1,25 @@ +/* + * 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. + */ +/** + *

Provides classes for handling and manipulating text, partly as an extension to {@link java.text}. + * The classes in this package are, for the most part, intended to be instantiated (i.e. they are not utility classes + * with lots of static methods).

+ * + * @since 2.1 + * @version $Id$ + */ +package org.apache.commons.lang3.text; diff --git a/src/main/java/org/apache/commons/lang3/text/package.html b/src/main/java/org/apache/commons/lang3/text/package.html deleted file mode 100644 index bf39f0397..000000000 --- a/src/main/java/org/apache/commons/lang3/text/package.html +++ /dev/null @@ -1,26 +0,0 @@ - - - -

-Provides classes for handling and manipulating text, partly as an extension to {@link java.text}. -The classes in this package are, for the most part, intended to be instantiated. -(ie. they are not utility classes with lots of static methods) -

-@since 2.1 - - diff --git a/src/main/java/org/apache/commons/lang3/text/translate/package-info.java b/src/main/java/org/apache/commons/lang3/text/translate/package-info.java new file mode 100644 index 000000000..fd47b62cb --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/text/translate/package-info.java @@ -0,0 +1,25 @@ +/* + * 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. + */ +/** + *

An API for creating text translation routines from a set of smaller building blocks. Initially created to make it + * possible for the user to customize the rules in the StringEscapeUtils class.

+ *

These classes are immutable, and therefore thread-safe.

+ * + * @since 3.0 + * @version $Id$ + */ +package org.apache.commons.lang3.text.translate; diff --git a/src/main/java/org/apache/commons/lang3/text/translate/package.html b/src/main/java/org/apache/commons/lang3/text/translate/package.html deleted file mode 100644 index ac0911896..000000000 --- a/src/main/java/org/apache/commons/lang3/text/translate/package.html +++ /dev/null @@ -1,27 +0,0 @@ - - - -

-An API for creating text translation routines from a set of smaller -building blocks. Initially created to make it possible for the user to -customize the rules in the StringEscapeUtils class. -

-@since 3.0 -

These classes are immutable, and therefore thread-safe.

- - diff --git a/src/main/java/org/apache/commons/lang3/time/package-info.java b/src/main/java/org/apache/commons/lang3/time/package-info.java new file mode 100644 index 000000000..ae0155f82 --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/time/package-info.java @@ -0,0 +1,24 @@ +/* + * 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. + */ +/** + *

Provides classes and methods to work with dates and durations.

+ *

These classes are immutable (and therefore thread-safe) apart from {@link org.apache.commons.lang3.time.StopWatch}.

+ * + * @since 2.0 + * @version $Id$ + */ +package org.apache.commons.lang3.time; diff --git a/src/main/java/org/apache/commons/lang3/time/package.html b/src/main/java/org/apache/commons/lang3/time/package.html deleted file mode 100644 index 28320932b..000000000 --- a/src/main/java/org/apache/commons/lang3/time/package.html +++ /dev/null @@ -1,23 +0,0 @@ - - - -Provides classes and methods to work with dates and durations. -@since 2.0 -

These classes are immutable (and therefore thread-safe) apart from {@link org.apache.commons.lang3.time.StopWatch}.

- - diff --git a/src/main/java/org/apache/commons/lang3/tuple/package-info.java b/src/main/java/org/apache/commons/lang3/tuple/package-info.java new file mode 100644 index 000000000..7d309d6c2 --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/tuple/package-info.java @@ -0,0 +1,23 @@ +/* + * 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. + */ +/** + * Tuple classes, starting with a Pair class in version 3.0. + * + * @since 3.0 + * @version $Id$ + */ +package org.apache.commons.lang3.tuple; diff --git a/src/main/java/org/apache/commons/lang3/tuple/package.html b/src/main/java/org/apache/commons/lang3/tuple/package.html deleted file mode 100644 index db8585393..000000000 --- a/src/main/java/org/apache/commons/lang3/tuple/package.html +++ /dev/null @@ -1,22 +0,0 @@ - - - -Tuple classes, starting with a Pair class in version 3.0. -@since 3.0 - -