| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| LeftBoundProcedure |
|
| 2.5714285714285716;2.571 |
| 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 | * http://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.functor.adapter; | |
| 18 | ||
| 19 | import java.io.Serializable; | |
| 20 | ||
| 21 | import org.apache.commons.functor.BinaryProcedure; | |
| 22 | import org.apache.commons.functor.UnaryProcedure; | |
| 23 | ||
| 24 | /** | |
| 25 | * Adapts a | |
| 26 | * {@link BinaryProcedure BinaryProcedure} | |
| 27 | * to the | |
| 28 | * {@link UnaryProcedure UnaryProcedure} interface | |
| 29 | * using a constant left-side argument. | |
| 30 | * <p/> | |
| 31 | * Note that although this class implements | |
| 32 | * {@link Serializable}, a given instance will | |
| 33 | * only be truly <code>Serializable</code> if the | |
| 34 | * underlying objects are. Attempts to serialize | |
| 35 | * an instance whose delegates are not | |
| 36 | * <code>Serializable</code> will result in an exception. | |
| 37 | * | |
| 38 | * @param <A> the argument type. | |
| 39 | * @version $Revision: 1157625 $ $Date: 2011-08-14 22:01:43 +0200 (Sun, 14 Aug 2011) $ | |
| 40 | * @author Rodney Waldhoff | |
| 41 | */ | |
| 42 | public final class LeftBoundProcedure<A> implements UnaryProcedure<A>, Serializable { | |
| 43 | /** | |
| 44 | * serialVersionUID declaration. | |
| 45 | */ | |
| 46 | private static final long serialVersionUID = 7650992440581629785L; | |
| 47 | /** The {@link BinaryProcedure BinaryProcedure} I'm wrapping. */ | |
| 48 | private final BinaryProcedure<Object, ? super A> procedure; | |
| 49 | /** The parameter to pass to {@code procedure}. */ | |
| 50 | private final Object param; | |
| 51 | ||
| 52 | /** | |
| 53 | * Create a new LeftBoundProcedure. | |
| 54 | * @param <L> the left argument type. | |
| 55 | * @param procedure the procedure to adapt | |
| 56 | * @param arg the constant argument to use | |
| 57 | */ | |
| 58 | @SuppressWarnings("unchecked") | |
| 59 | 24 | public <L> LeftBoundProcedure(BinaryProcedure<? super L, ? super A> procedure, L arg) { |
| 60 | 24 | if (procedure == null) { |
| 61 | 0 | throw new IllegalArgumentException("BinaryProcedure argument was null"); |
| 62 | } | |
| 63 | 24 | this.procedure = (BinaryProcedure<Object, ? super A>) procedure; |
| 64 | 24 | this.param = arg; |
| 65 | 24 | } |
| 66 | ||
| 67 | /** | |
| 68 | * {@inheritDoc} | |
| 69 | */ | |
| 70 | public void run(A obj) { | |
| 71 | 4 | procedure.run(param, obj); |
| 72 | 4 | } |
| 73 | ||
| 74 | /** | |
| 75 | * {@inheritDoc} | |
| 76 | */ | |
| 77 | public boolean equals(Object that) { | |
| 78 | 30 | return that == this || (that instanceof LeftBoundProcedure<?> && equals((LeftBoundProcedure<?>) that)); |
| 79 | } | |
| 80 | ||
| 81 | /** | |
| 82 | * Learn whether another LeftBoundProcedure is equal to this. | |
| 83 | * @param that LeftBoundProcedure to test | |
| 84 | * @return boolean | |
| 85 | */ | |
| 86 | public boolean equals(LeftBoundProcedure<?> that) { | |
| 87 | 22 | return null != that |
| 88 | && (null == procedure ? null == that.procedure : procedure.equals(that.procedure)) | |
| 89 | && (null == param ? null == that.param : param.equals(that.param)); | |
| 90 | } | |
| 91 | ||
| 92 | /** | |
| 93 | * {@inheritDoc} | |
| 94 | */ | |
| 95 | public int hashCode() { | |
| 96 | 32 | int hash = "LeftBoundProcedure".hashCode(); |
| 97 | 32 | if (null != procedure) { |
| 98 | 32 | hash <<= 2; |
| 99 | 32 | hash ^= procedure.hashCode(); |
| 100 | } | |
| 101 | 32 | if (null != param) { |
| 102 | 30 | hash <<= 2; |
| 103 | 30 | hash ^= param.hashCode(); |
| 104 | } | |
| 105 | 32 | return hash; |
| 106 | } | |
| 107 | ||
| 108 | /** | |
| 109 | * {@inheritDoc} | |
| 110 | */ | |
| 111 | public String toString() { | |
| 112 | 24 | return "LeftBoundProcedure<" + procedure + "(" + param + ",?)>"; |
| 113 | } | |
| 114 | ||
| 115 | /** | |
| 116 | * Get a UnaryProcedure from <code>procedure</code>. | |
| 117 | * @param <L> left type | |
| 118 | * @param <R> right type | |
| 119 | * @param procedure to adapt | |
| 120 | * @param arg left side argument | |
| 121 | * @return LeftBoundProcedure<R> | |
| 122 | */ | |
| 123 | public static <L, R> LeftBoundProcedure<R> bind(BinaryProcedure<? super L, ? super R> procedure, L arg) { | |
| 124 | 6 | return null == procedure ? null : new LeftBoundProcedure<R>(procedure, arg); |
| 125 | } | |
| 126 | ||
| 127 | } |