25 | * We only offer specializations for Integer, Long, and Double (like Java Streams). 26 | *
27 | * 28 | * @param42 | * This is the same as the expression: 43 | *
44 | *45 | * (B) this 46 | *47 | * 48 | * @return this instance typed as the subclass type {@code B}. 49 | */ 50 | @SuppressWarnings("unchecked") 51 | protected B asThis() { 52 | return (B) this; 53 | } 54 | 55 | } 56 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/builder/DiffExclude.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | package org.apache.commons.lang3.builder; 19 | 20 | import java.lang.annotation.ElementType; 21 | import java.lang.annotation.Retention; 22 | import java.lang.annotation.RetentionPolicy; 23 | import java.lang.annotation.Target; 24 | 25 | /** 26 | * Excludes a field from being used by the {@link ReflectionDiffBuilder}. 27 | * 28 | * @since 3.13.0 29 | */ 30 | @Retention(RetentionPolicy.RUNTIME) 31 | @Target(ElementType.FIELD) 32 | public @interface DiffExclude { 33 | // empty 34 | } 35 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | package org.apache.commons.lang3.builder; 19 | 20 | import java.lang.annotation.ElementType; 21 | import java.lang.annotation.Retention; 22 | import java.lang.annotation.RetentionPolicy; 23 | import java.lang.annotation.Target; 24 | 25 | /** 26 | * Excludes a field from being used by the various {@code reflectionEquals} methods defined on {@link EqualsBuilder}. 27 | * 28 | * @since 3.5 29 | */ 30 | @Retention(RetentionPolicy.RUNTIME) 31 | @Target(ElementType.FIELD) 32 | public @interface EqualsExclude { 33 | // empty 34 | } 35 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | package org.apache.commons.lang3.builder; 19 | 20 | import java.lang.annotation.ElementType; 21 | import java.lang.annotation.Retention; 22 | import java.lang.annotation.RetentionPolicy; 23 | import java.lang.annotation.Target; 24 | 25 | /** 26 | * Exclude a field from being used by the various {@code reflectionHashcode} methods defined on {@link HashCodeBuilder}. 27 | * 28 | * @since 3.5 29 | */ 30 | @Retention(RetentionPolicy.RUNTIME) 31 | @Target(ElementType.FIELD) 32 | public @interface HashCodeExclude { 33 | // empty 34 | } 35 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/builder/Reflection.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | package org.apache.commons.lang3.builder; 19 | 20 | import java.lang.reflect.Field; 21 | import java.util.Objects; 22 | 23 | /** 24 | * Package-private reflection code. 25 | */ 26 | final class Reflection { 27 | 28 | /** 29 | * Delegates to {@link Field#get(Object)} and rethrows {@link IllegalAccessException} as {@link IllegalArgumentException}. 30 | * 31 | * @param field The receiver of the get call. 32 | * @param obj The argument of the get call. 33 | * @return The result of the get call. 34 | * @throws IllegalArgumentException Thrown after catching {@link IllegalAccessException}. 35 | */ 36 | static Object getUnchecked(final Field field, final Object obj) { 37 | try { 38 | return Objects.requireNonNull(field, "field").get(obj); 39 | } catch (final IllegalAccessException e) { 40 | throw new IllegalArgumentException(e); 41 | } 42 | } 43 | 44 | } 45 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | package org.apache.commons.lang3.builder; 19 | 20 | import java.lang.annotation.ElementType; 21 | import java.lang.annotation.Retention; 22 | import java.lang.annotation.RetentionPolicy; 23 | import java.lang.annotation.Target; 24 | 25 | /** 26 | * Excludes a field from being used by the {@link ReflectionToStringBuilder}. 27 | * 28 | * @since 3.5 29 | */ 30 | @Retention(RetentionPolicy.RUNTIME) 31 | @Target(ElementType.FIELD) 32 | public @interface ToStringExclude { 33 | // empty 34 | } 35 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/builder/ToStringSummary.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | package org.apache.commons.lang3.builder; 19 | 20 | import java.lang.annotation.ElementType; 21 | import java.lang.annotation.Retention; 22 | import java.lang.annotation.RetentionPolicy; 23 | import java.lang.annotation.Target; 24 | 25 | /** 26 | * Use this annotation on the fields to get the summary instead of the detailed 27 | * information when using {@link ReflectionToStringBuilder}. 28 | * 29 | *
30 | * Notice that not all {@link ToStringStyle} implementations support the 31 | * appendSummary method. 32 | *
33 | * 34 | * @since 3.8 35 | */ 36 | @Retention(RetentionPolicy.RUNTIME) 37 | @Target(ElementType.FIELD) 38 | public @interface ToStringSummary { 39 | // empty 40 | } 41 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/builder/package-info.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | /** 19 | * Provides classes to create consistent {@code equals(Object)}, {@code toString()}, {@code hashCode()}, and {@code compareTo(Object)} methods. 20 | * These classes are not thread-safe. 21 | * 22 | *When you write a {@link Object#hashCode() hashCode()}, do you check Bloch's Effective Java? No? 23 | * You just hack in a quick number? 24 | * Well {@link org.apache.commons.lang3.builder.HashCodeBuilder} will save your day. 25 | * It, and its buddies ({@link org.apache.commons.lang3.builder.EqualsBuilder}, {@link org.apache.commons.lang3.builder.CompareToBuilder}, {@link org.apache.commons.lang3.builder.ToStringBuilder}), take care of the nasty bits while you focus on the important bits, like which fields will go into making up the hash code.
26 | * 27 | * @see Object#equals(Object) 28 | * @see Object#toString() 29 | * @see Object#hashCode() 30 | * @see Comparable#compareTo(Object) 31 | * @since 1.0 32 | */ 33 | package org.apache.commons.lang3.builder; 34 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/compare/package-info.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | /** 19 | * Provides classes to work with the {@link Comparable} and {@link java.util.Comparator} interfaces. 20 | * 21 | * @since 3.10 22 | */ 23 | package org.apache.commons.lang3.compare; 24 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/concurrent/Computable.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | package org.apache.commons.lang3.concurrent; 18 | 19 | import org.apache.commons.lang3.function.FailableFunction; 20 | 21 | /** 22 | * Definition of an interface for a wrapper around a calculation that takes a single parameter and returns a result. 23 | * 24 | *This interface allows for wrapping a calculation into a class so that it maybe passed around an application.
25 | * 26 | *See also {@code FailableFunction
22 | * Subclasses should only be used to wrap checked exception. 23 | *
24 | * 25 | * @since 3.13.0 26 | */ 27 | public class UncheckedException extends RuntimeException { 28 | 29 | private static final long serialVersionUID = 1L; 30 | 31 | /** 32 | * Constructs an instance initialized to the given {@code cause}. 33 | * 34 | * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A {@code null} value 35 | * is permitted, and indicates that the cause is nonexistent or unknown.) 36 | */ 37 | public UncheckedException(final Throwable cause) { 38 | super(cause); 39 | } 40 | 41 | } 42 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/exception/UncheckedIllegalAccessException.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | package org.apache.commons.lang3.exception; 19 | 20 | /** 21 | * Unchecked {@link IllegalAccessException}. 22 | * 23 | * @since 3.13.0 24 | */ 25 | public class UncheckedIllegalAccessException extends UncheckedReflectiveOperationException { 26 | 27 | private static final long serialVersionUID = 1L; 28 | 29 | /** 30 | * Constructs an instance initialized to the given {@code cause}. 31 | * 32 | * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A {@code null} value 33 | * is permitted, and indicates that the cause is nonexistent or unknown.) 34 | */ 35 | public UncheckedIllegalAccessException(final Throwable cause) { 36 | super(cause); 37 | } 38 | 39 | } 40 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/exception/UncheckedInterruptedException.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | package org.apache.commons.lang3.exception; 18 | 19 | /** 20 | * Unchecked {@link InterruptedException}. 21 | * 22 | * @since 3.13.0 23 | */ 24 | public class UncheckedInterruptedException extends UncheckedException { 25 | 26 | private static final long serialVersionUID = 1L; 27 | 28 | /** 29 | * Constructs an instance initialized to the given {@code cause}. 30 | * 31 | * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A {@code null} value 32 | * is permitted, and indicates that the cause is nonexistent or unknown.) 33 | */ 34 | public UncheckedInterruptedException(final Throwable cause) { 35 | super(cause); 36 | } 37 | 38 | } 39 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/exception/UncheckedReflectiveOperationException.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | package org.apache.commons.lang3.exception; 18 | 19 | /** 20 | * Unchecked {@link ReflectiveOperationException}. 21 | * 22 | * @since 3.13.0 23 | */ 24 | public class UncheckedReflectiveOperationException extends UncheckedException { 25 | 26 | private static final long serialVersionUID = 1L; 27 | 28 | /** 29 | * Constructs an instance initialized to the given {@code cause}. 30 | * 31 | * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A {@code null} value 32 | * is permitted, and indicates that the cause is nonexistent or unknown.) 33 | */ 34 | public UncheckedReflectiveOperationException(final Throwable cause) { 35 | super(cause); 36 | } 37 | 38 | } 39 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/exception/package-info.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | /** 19 | * Provides functionality for Exceptions. 20 | *Contains the concept of an exception with context i.e. such an exception will contain a map with keys and values. 21 | * This provides an easy way to pass valuable state information at exception time in useful form to a calling process.
22 | *Lastly, {@link org.apache.commons.lang3.exception.ExceptionUtils} also contains {@link Throwable} manipulation 23 | * and examination routines.
24 | * 25 | * @since 1.0 26 | */ 27 | package org.apache.commons.lang3.exception; 28 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/function/FailableBooleanSupplier.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | package org.apache.commons.lang3.function; 19 | 20 | import java.util.function.BooleanSupplier; 21 | 22 | /** 23 | * A functional interface like {@link BooleanSupplier} that declares a {@link Throwable}. 24 | * 25 | * @param27 | * This is a functional interface whose functional method is {@link #applyAsChar(int)}. 28 | *
29 | * 30 | * @see Function 31 | * @since 3.13.0 32 | */ 33 | @FunctionalInterface 34 | public interface IntToCharFunction { 35 | 36 | /** 37 | * Applies this function to the given argument. 38 | * 39 | * @param value the function argument. 40 | * @return the function result. 41 | */ 42 | char applyAsChar(int value); 43 | } 44 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/function/Predicates.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | package org.apache.commons.lang3.function; 19 | 20 | import java.util.function.Predicate; 21 | 22 | /** 23 | * Factory for {@link Predicate}. 24 | * 25 | * @since 3.18.0 26 | */ 27 | public class Predicates { 28 | 29 | private static final Predicate ALWAYS_TRUE = t -> true; 30 | private static final Predicate ALWAYS_FALSE = t -> false; 31 | 32 | /** 33 | * Returns the Predicate singleton that always returns false. 34 | * 35 | * @param23 | * Contains failable functional interfaces that address the fact that lambdas are supposed not to throw Exceptions, at 24 | * least not checked Exceptions, A.K.A. instances of {@link Exception}. A failable functional interface 25 | * declares a type of Exception that may be raised if the function fails. 26 | *
27 | * 28 | * @since 3.11 29 | */ 30 | package org.apache.commons.lang3.function; 31 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/mutable/Mutable.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | package org.apache.commons.lang3.mutable; 19 | 20 | /** 21 | * Provides mutable access to a value. 22 | *23 | * {@link Mutable} is used as a generic interface to the implementations in this package. 24 | *
25 | *26 | * A typical use case would be to enable a primitive or string to be passed to a method and allow that method to 27 | * effectively change the value of the primitive/string. Another use case is to store a frequently changing primitive in 28 | * a collection (for example a total in a map) without needing to create new Integer/Long wrapper objects. 29 | *
30 | * 31 | * @paramThese classes are immutable and thread-safe.
21 | * 22 | * @since 3.0 23 | */ 24 | package org.apache.commons.lang3.reflect; 25 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/stream/package-info.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | /** 19 | * Provides utility classes to complement those in {@link java.util.stream}. 20 | * 21 | *Contains utilities to allow streaming of failable functional interfaces from the 22 | * {@code org.apache.commons.lang3.functions} package allowing streaming of functional expressions 23 | * that may raise an Exception. 24 | * 25 | * @since 3.11 26 | */ 27 | package org.apache.commons.lang3.stream; 28 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/text/FormatFactory.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | package org.apache.commons.lang3.text; 18 | 19 | import java.text.Format; 20 | import java.util.Locale; 21 | 22 | /** 23 | * Format factory. 24 | * 25 | * @since 2.4 26 | * @deprecated As of 3.6, use Apache Commons Text 27 | * 28 | * FormatFactory. 29 | */ 30 | @Deprecated 31 | public interface FormatFactory { 32 | 33 | /** 34 | * Create or retrieve a format instance. 35 | * 36 | * @param name The format type name 37 | * @param arguments Arguments used to create the format instance. This allows the 38 | * {@link FormatFactory} to implement the "format style" 39 | * concept from {@link java.text.MessageFormat}. 40 | * @param locale The locale, may be null 41 | * @return The format instance 42 | */ 43 | Format getFormat(String name, String arguments, Locale locale); 44 | 45 | } 46 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/text/package-info.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | /** 19 | * Deprecated: Provides classes for handling and manipulating text, partly as an extension to {@link java.text}. The classes in this package 20 | * are, for the most part, intended to be instantiated (i.e. they are not utility classes with lots of static methods). 21 | * 22 | *
23 | * Amongst other classes, the text package provides a replacement for {@link StringBuffer} named {@link org.apache.commons.lang3.text.StrBuilder}, a class for 24 | * substituting variables within a String named {@link org.apache.commons.lang3.text.StrSubstitutor} and a replacement for {@link java.util.StringTokenizer} 25 | * named {@link org.apache.commons.lang3.text.StrTokenizer}. While somewhat ungainly, the {@code Str} prefix has been used to ensure we don't clash with any 26 | * current or future standard Java classes. 27 | *
28 | *29 | * Deprecated: As of 3.6, use the Apache Commons Text 30 | * text package. 31 | *
32 | * 33 | * @since 2.1 34 | */ 35 | package org.apache.commons.lang3.text; 36 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | package org.apache.commons.lang3.text.translate; 18 | 19 | import java.io.IOException; 20 | import java.io.Writer; 21 | 22 | /** 23 | * Helper subclass to CharSequenceTranslator to remove unpaired surrogates. 24 | * 25 | * @deprecated As of 3.6, use Apache Commons Text 26 | * 27 | * UnicodeUnpairedSurrogateRemover. 28 | */ 29 | @Deprecated 30 | public class UnicodeUnpairedSurrogateRemover extends CodePointTranslator { 31 | 32 | /** 33 | * Constructs a new instance. 34 | */ 35 | public UnicodeUnpairedSurrogateRemover() { 36 | // empty 37 | } 38 | 39 | /** 40 | * Implements translate that throws out unpaired surrogates. 41 | * {@inheritDoc} 42 | */ 43 | @Override 44 | public boolean translate(final int codePoint, final Writer out) throws IOException { 45 | // true: It's a surrogate. Write nothing and say we've translated. 46 | return codePoint >= Character.MIN_SURROGATE && codePoint <= Character.MAX_SURROGATE; 47 | // It's not a surrogate. Don't translate it. 48 | } 49 | } 50 | 51 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/text/translate/package-info.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | /** 19 | * Deprecated: Provides text translation routines from a set of smaller building blocks. Initially created to make it possible for the user to 20 | * customize the rules in the StringEscapeUtils class. 21 | *22 | * These classes are immutable, and therefore thread-safe. 23 | *
24 | *25 | * Deprecated: As of 3.6, use the Apache Commons Text 26 | * translate package. 27 | *
28 | * 29 | * @since 3.0 30 | */ 31 | package org.apache.commons.lang3.text.translate; 32 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/time/TimeZones.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | package org.apache.commons.lang3.time; 19 | 20 | import java.util.TimeZone; 21 | 22 | import org.apache.commons.lang3.ObjectUtils; 23 | 24 | /** 25 | * Helps to deal with {@link java.util.TimeZone}s. 26 | * 27 | * @since 3.7 28 | */ 29 | public class TimeZones { 30 | 31 | /** 32 | * A public version of {@link java.util.TimeZone}'s package private {@code GMT_ID} field. 33 | */ 34 | public static final String GMT_ID = "GMT"; 35 | 36 | /** 37 | * The GMT time zone. 38 | * 39 | * @since 3.13.0 40 | */ 41 | public static final TimeZone GMT = TimeZone.getTimeZone(GMT_ID); 42 | 43 | /** 44 | * Returns the given TimeZone if non-{@code null}, otherwise {@link TimeZone#getDefault()}. 45 | * 46 | * @param timeZone a locale or {@code null}. 47 | * @return the given locale if non-{@code null}, otherwise {@link TimeZone#getDefault()}. 48 | * @since 3.13.0 49 | */ 50 | public static TimeZone toTimeZone(final TimeZone timeZone) { 51 | return ObjectUtils.getIfNull(timeZone, TimeZone::getDefault); 52 | } 53 | 54 | /** Do not instantiate. */ 55 | private TimeZones() { 56 | } 57 | 58 | } 59 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/time/package-info.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | /** 19 | * Provides classes and methods to work with dates and durations. 20 | * These classes are immutable (and therefore thread-safe) apart from {@link org.apache.commons.lang3.time.StopWatch}. 21 | * 22 | *The time package contains some basic utilities for manipulating time (a delorean, police box and grandfather clock?). 23 | * These include a {@link org.apache.commons.lang3.time.StopWatch} for simple performance measurements and an optimized {@link org.apache.commons.lang3.time.FastDateFormat} class.
24 | * 25 | * @since 2.0 26 | */ 27 | package org.apache.commons.lang3.time; 28 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/tuple/package-info.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | /** 19 | * Provides tuple classes, both mutable and immutable {@link Pair} and {@link Triple}. 20 | * 21 | * @since 3.0 22 | */ 23 | package org.apache.commons.lang3.tuple; 24 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/lang3/util/package-info.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * https://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | /** 19 | * Provides classes that work with the Java {@link java.util} package. 20 | * 21 | * @since 3.13.0 22 | */ 23 | package org.apache.commons.lang3.util; 24 | -------------------------------------------------------------------------------- /src/media/logo.xcf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/apache/commons-lang/13aebc396de9233b8f913afa4b02f62f9d11f819/src/media/logo.xcf -------------------------------------------------------------------------------- /src/site/resources/.htaccess: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one or more 2 | # contributor license agreements. See the NOTICE file distributed with 3 | # this work for additional information regarding copyright ownership. 4 | # The ASF licenses this file to You under the Apache License, Version 2.0 5 | # (the "License"); you may not use this file except in compliance with 6 | # the License. You may obtain a copy of the License at 7 | # 8 | # https://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | 16 | AddCharset utf-8 .txt .html 17 | -------------------------------------------------------------------------------- /src/site/resources/checkstyle/checkstyle-suppressions.xml: -------------------------------------------------------------------------------- 1 | 2 | 18 | 21 |31 | The User Guide has moved to the package Javadoc. 32 |
33 |