| /* |
| * 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. |
| */ |
| package org.apache.commons.functor.adapter; |
| |
| import java.io.Serializable; |
| |
| import org.apache.commons.functor.Function; |
| import org.apache.commons.functor.Procedure; |
| import org.apache.commons.lang3.Validate; |
| |
| /** |
| * Adapts a {@link Function Function} |
| * to the {@link Procedure Procedure} |
| * interface by ignoring the value returned |
| * by the function. |
| * <p/> |
| * Note that although this class implements |
| * {@link Serializable}, a given instance will |
| * only be truly <code>Serializable</code> if the |
| * underlying function is. Attempts to serialize |
| * an instance whose delegate is not |
| * <code>Serializable</code> will result in an exception. |
| * |
| * @param <A> the argument type. |
| * @version $Revision$ $Date$ |
| */ |
| public final class FunctionProcedure<A> implements Procedure<A>, Serializable { |
| |
| /** |
| * serialVersionUID declaration. |
| */ |
| private static final long serialVersionUID = -3578673875995684811L; |
| /** The {@link Function Function} I'm wrapping. */ |
| private final Function<? super A, ?> function; |
| |
| /** |
| * Create an {@link Procedure Procedure} wrapping |
| * the given {@link Function Function}. |
| * @param function the {@link Function Function} to wrap |
| */ |
| public FunctionProcedure(Function<? super A, ?> function) { |
| this.function = Validate.notNull(function, "Function argument was null"); |
| } |
| |
| /** |
| * {@link Function#evaluate Evaluate} my function, but |
| * ignore its returned value. |
| * {@inheritDoc} |
| */ |
| public void run(A obj) { |
| function.evaluate(obj); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public boolean equals(Object obj) { |
| if (obj == this) { |
| return true; |
| } |
| if (!(obj instanceof FunctionProcedure<?>)) { |
| return false; |
| } |
| FunctionProcedure<?> that = (FunctionProcedure<?>) obj; |
| return this.function.equals(that.function); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public int hashCode() { |
| int hash = "FunctionProcedure".hashCode(); |
| hash ^= function.hashCode(); |
| return hash; |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public String toString() { |
| return "FunctionProcedure<" + function + ">"; |
| } |
| |
| /** |
| * Adapt the given, possibly-<code>null</code>, |
| * {@link Function Function} to the |
| * {@link Procedure Procedure} interface. |
| * When the given <code>Function</code> is <code>null</code>, |
| * returns <code>null</code>. |
| * |
| * @param <A> the argument type. |
| * @param function the possibly-<code>null</code> |
| * {@link Function Function} to adapt |
| * @return a {@link Procedure Procedure} wrapping the given |
| * {@link Function Function}, or <code>null</code> |
| * if the given <code>Function</code> is <code>null</code> |
| */ |
| public static <A> FunctionProcedure<A> adapt(Function<? super A, ?> function) { |
| return null == function ? null : new FunctionProcedure<A>(function); |
| } |
| |
| } |