/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */
package org.apache.commons.lang.builder;

import java.lang.reflect.Field;
import java.lang.reflect.Modifier;

import org.apache.commons.lang.NumberUtils;
/** 
 * <code>CompareTo</code> を生成する処理です。
 * {@primary <code>CompareTo</code> generation routines.}
 * <p>
 * このクラスはより良い <comde>compareTo()</code> メソッドをクラスに実装するためのメソッドを提供します。
 * これは EqualsBuilder と HashCodeBuilder によって実装された
 * <code>equals</code> と <code>hashcode</code> と調和的です。
 * {@primary This class provides methods to build a good <comde>compareTo()</code> method for any class.
 * It is consistent with the <code>equals</code> and <code>hashcode</code> built
 * with EqualsBuilder and HashCodeBuilder.}
 * <p>
 * equals メソッドで等しいと判定された2つのオブジェクトは、compareTo でも等しいと判定されるべきです。
 * {@primary Two object that compare equal using equals should compare equals using
 * compareTo.}
 * <p>
 * 全ての関連のあるフィールドを比較を行う際の計算に含めるべきです。
 * 取得されたフィールドは無視されるかもしれません(訳注 毎回登録した全てのフィールドを計算するわけではないと言う意味?)。
 * 使用されるフィールドとその順番は <code>compareTo</code> と <code>equals</code> で同じであるべきです。
 * {@primary All relevant fields should be included in the calculation of the comparison. Derived
 * fields may be ignored. The same fields, in the same order, should be used in
 * both <code>compareTo</code> and <code>equals</code>.}
 * <p>
 * 一般的な使用方法を以下に示します:
 * {@primary Typical use for the code is as follows:}
 *
 * <pre>
 *  public int comapareTo(Object o) {
 *    MyClass rhs = (MyClass) o;
 *    return new CompareToBuilder()
 *                 .append(field1, rhs.field1)
 *                 .append(field2, rhs.field2)
 *                 .appendb(field3, rhs.field3)
 *                 .toComparison();
 *  }
 * </pre>
 * <p>
 * もう一つの方法として、リフレクションを使用してフィールドを比較するメソッドがあります。
 * 普通、対象となるフィールドは private であるため、この <code>reflectionCompare</code>
 * メソッドは フィールドのアクセス制限を変更するために  <code>Field.setAccessible</code> 
 * を使用します。
 * これは適切なパーミッションが設定されていない限り、セキュリティマネージャが稼動している状態では行うことができません。
 * また、この方法は明らかに低速です。
 * {@primary Alternatively, there is a method that uses reflection to determine
 * the fields to test. Because these fields are usually private, the method,
 * <code>reflectionCompare</code>, uses <code>Field.setAccessible</code> to change
 * the visibility of the fields. This will fail under a security manager,
 * unless the appropriate permissions are set. It is also slower than testing
 * explicitly.}
 * <p>
 * このメソッドの一般的な使用方法は以下の様になります:
 * {@primary A typical invocation for this method would look like:}
 * <pre>
 * public int compareTo(Object o) {
 *   return CompareToBuilder.reflectionCompare(this, obj);
 * }
 * </pre>
 * @author <a href="mailto:steve.downey@netfolio.com">Steve Downey</a>
 * @author <a href="mailto:scolebourne@joda.org">Stephen Colebourne</a>
 * @translator 日置 聡
 * @status firstdraft
 * @update 2003/08/18
 * @version $Id: CompareToBuilder.java,v 1.1.1.1 2004/02/13 10:02:04 hioki Exp $
 */
public class CompareToBuilder {
    /**
     * テストされたフィールドが等しいかどうか。
     * {@primary If the fields tested are equals.}
     */
    private int comparison;

    /**
     * CompareToBuilder のコンストラクタです。
     * 初期状態では(2つの)オブジェクトは等しいとみなされます。
     * {@primary Constructor for CompareToBuilder.
     * Starts off assuming that the objects are equal.}
     * @see java.lang.Object#Object()
     */
    public CompareToBuilder() {
        super();
        comparison = 0;
    }

    //-------------------------------------------------------------------------
    
    /** 
     * このメソッドは指定された2つのオブジェクトを測定するためにリフレクションを使用します。
     * {@primary This method uses reflection to determine the ordering between two objects.}
     * <p>
     * このメソッドは private フィールドの値を取得するために Field.setAccessible を使用します。
     * これはセキュリティマネージャが稼動していて、適切なパーミッションが設定されていない場合、
     * セキュリティ例外が投げられることを意味します。
     * このメソッドは明らかに非効率です。
     * transient メンバーは、おそらくフィールドの値から取得されたものでオブジェクトの値とはならないと考え、
     * 処理の対象としません。
     * static フィールドは処理の対象にはなりません。
     * {@primary It uses Field.setAccessible to gain access to private fields. This means
     * that it will throw a security exception if run under a security manger, if
     * the permissions are not set up.
     * It is also not as efficient as testing explicitly.
     * Transient members will be not be tested, as they are likely derived
     * fields, and not part of the value of the object.
     * Static fields will not be tested.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return このオブジェクトの方が小さい場合マイナスの値、等しい場合0、大きい場合プラスの値
     * {@primary a negative integer, zero, or a positive integer as this 
     * object is less than, equal to, or greater than the specified object.}
     * @throws NullPointerException  どちらか片方の引数が null の場合
     * {@primary if either (but not both) parameter is null}
     * @throws ClassCastException  指定されたオブジェクト型が自身の比較を行えない場合
     * {@primary if the specified object's type prevents it from being compared to this Object.}
     */
    public static int reflectionCompare(Object lhs, Object rhs) {
        return reflectionCompare(lhs, rhs, false);
    }

    /**
     * このメソッドは指定された2つのオブジェクトを測定するためにリフレクションを使用します。
     * {@primary This method uses reflection to determine if the two object are equal. }
     * <p>
     * このメソッドは private フィールドの値を取得するために Field.setAccessible を使用します。
     * これはセキュリティマネージャが稼動していて、適切なパーミッションが設定されていない場合、
     * セキュリティ例外が投げられることを意味します。
     * このメソッドは明らかに非効率です。
     * testTransients 引数に true が設定された場合 transient メンバーを処理の対象とし、
     * false が設定された場合にはフィールドの値から取得されたものでオブジェクトの値とはならないとみなし、
     * transient メンバーを無視します。
     * static フィールドは処理の対象にはなりません。
     * {@primary It uses Field.setAccessible to gain access to private fields. This means
     * that it will throw a security exception if run under a security manger, if
     * the permissions are not set up.
     * It is also not as efficient as testing explicitly. 
     * If the TestTransients parameter is set to true, transient members will be
     * tested, otherwise they are ignored, as they are likely derived fields, and
     * not part of the value of the object. 
     * Static fields will not be tested.}
     * 
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @param testTransients transient フィールドを含めるかどうか
     * {@primary whether to include transient fields}
     * @return このオブジェクトの方が小さい場合マイナスの値、等しい場合0、大きい場合プラスの値
     * {@primary a negative integer, zero, or a positive integer as this 
     * object is less than, equal to, or greater than the specified object.}
     * @throws NullPointerException  どちらか片方の引数が null の場合
     * {@primary if either (but not both) parameter is null}
     * @throws ClassCastException  指定されたオブジェクト型が自身の比較を行えない場合
     * {@primary if the specified object's type prevents it from being compared to this Object.}
     */
    public static int reflectionCompare(Object lhs, Object rhs, 
            boolean testTransients) {
        if (lhs == rhs) {
            return 0;
        }
        if (lhs == null || rhs == null) {
            throw new NullPointerException();
        }
        Class c1 = lhs.getClass();
        if (!c1.isInstance(rhs)) {
            throw new ClassCastException();
        }
        Field[] fields = c1.getDeclaredFields();
        Field.setAccessible(fields, true);
        CompareToBuilder compareToBuilder = new CompareToBuilder();
        for (int i = 0; i < fields.length && compareToBuilder.comparison == 0; ++i) {
            Field f = fields[i];
            if (testTransients || !Modifier.isTransient(f.getModifiers())) {
                if (!Modifier.isStatic(f.getModifiers())) {
                    try {
                        compareToBuilder.append(f.get(lhs), f.get(rhs));
                    } catch (IllegalAccessException e) {
                        //this can't happen. Would get a Security exception instead
                        //throw a runtime exception in case the impossible happens.
                        throw new InternalError("Unexpected IllegalAccessException");
                    }
                }
            }
        }
        return compareToBuilder.toComparison();
    }

    //-------------------------------------------------------------------------
    
    /** 
     * 2つの <code>Object</code> が等しいかどうかを各
     * <code>compareTo</code> メソッドを使用して評価します。
     * もし渡されたオブジェクトが配列だった場合には該当する比較を行います。
     * {@primary Test if two <code>Object</code>s are equal using either the
     * <code>compareTo</code> method, or native comparison if the Objects are
     * actually arrays.}
     * <p>
     * オブジェクトは <code>Comparable</code> である必要があります。
     * そうでなかった場合、このメソッドは <code>ClassCastException</code> を投げます。
     * {@primary The objects must be <code>Comparable</code>. If they are not, the method
     * will throw a <code>ClassCastException</code>.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     * @throws NullPointerException  どちらか片方の引数が null の場合
     * {@primary if either (but not both) parameter is null}
     * @throws ClassCastException  指定されたオブジェクト型が自身の比較を行えない場合
     * {@primary if the specified object's type prevents it from being compared to this Object.}
     */
    public CompareToBuilder append(Object lhs, Object rhs) {
        if (comparison != 0) {
            return this;
        }
        if (lhs == rhs) {
            return this;
        }
        if (lhs == null || rhs == null) {
            throw new NullPointerException();
        }
        Class lhsClass = lhs.getClass();
        if (!lhsClass.isArray()) {
            //the simple case, not an array, just test the element 
            comparison = ((Comparable) lhs).compareTo(rhs);
        } else {
            //'Switch' on type of array, to dispatch to the correct handler
            // This handles multi dimensional arrays
            if (lhs instanceof long[]) {
                append((long[]) lhs, (long[]) rhs);
            } else if (lhs instanceof int[]) {
                append((int[]) lhs, (int[]) rhs);
            } else if (lhs instanceof short[]) {
                append((short[]) lhs, (short[]) rhs);
            } else if (lhs instanceof char[]) {
                append((char[]) lhs, (char[]) rhs);
            } else if (lhs instanceof byte[]) {
                append((byte[]) lhs, (byte[]) rhs);
            } else if (lhs instanceof double[]) {
                append((double[]) lhs, (double[]) rhs);
            } else if (lhs instanceof float[]) {
                append((float[]) lhs, (float[]) rhs);
            } else if (lhs instanceof boolean[]) {
                append((boolean[]) lhs, (boolean[]) rhs);
            } else {
                // Not an array of primitives
                append((Object[]) lhs, (Object[]) rhs);
            }
        }
        return this;
    }

    /**
     * 2つの <code>long</code> の値の大きさ(&lt;、&gt;、==)を評価します。
     * {@primary Test if two <code>long</code>s are &lt;, &gt; or ==.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     */
    public CompareToBuilder append(long lhs, long rhs) {
        if (comparison != 0) {
            return this;
        }
        comparison = ((lhs < rhs) ? -1 : ((lhs > rhs) ? 1 : 0));
        return this;
    }

    /**
     * 2つの <code>int</code> の値の大きさ(&lt;、&gt;、==)を評価します。
     * {@primary Test if two <code>int</code>s are &lt;, &gt; or ==.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     */
    public CompareToBuilder append(int lhs, int rhs) {
        if (comparison != 0) {
            return this;
        }
        comparison = ((lhs < rhs) ? -1 : ((lhs > rhs) ? 1 : 0));
        return this;
    }

    /**
     * 2つの <code>short</code> の値の大きさ(&lt;、&gt;、==)を評価します。
     * {@primary Test if two <code>short</code>s are &lt;, &gt; or ==.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     */
    public CompareToBuilder append(short lhs, short rhs) {
        if (comparison != 0) {
            return this;
        }
        comparison = ((lhs < rhs) ? -1 : ((lhs > rhs) ? 1 : 0));
        return this;
    }

    /**
     * 2つの <code>char</code> の値の大きさ(&lt;、&gt;、==)を評価します。
     * {@primary Test if two <code>char</code>s are &lt;, &gt; or ==.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     */
    public CompareToBuilder append(char lhs, char rhs) {
        if (comparison != 0) {
            return this;
        }
        comparison = ((lhs < rhs) ? -1 : ((lhs > rhs) ? 1 : 0));
        return this;
    }

    /**
     * 2つの <code>byte</code> の値の大きさ(&lt;、&gt;、==)を評価します。
     * {@primary Test if two <code>byte</code>s are &lt;, &gt; or ==.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     */
    public CompareToBuilder append(byte lhs, byte rhs) {
        if (comparison != 0) {
            return this;
        }
        comparison = ((lhs < rhs) ? -1 : ((lhs > rhs) ? 1 : 0));
        return this;
    }

    /**
     * 2つの <code>double</code> の値の大きさ(&lt;、&gt;、==)を評価します。
     * これは NaN、無限大、-0.0 をハンドルします。
     * これは <code>HashCodeBuilder</code> によって生成されたハッシュコードと互換性を持ちます。
     * {@primary Test if two <code>double</code>s are &lt;, &gt; or ==. This handles NaNs, 
     * Infinties, and -0.0. It is compatible with the hash code generated by 
     * <code>HashCodeBuilder</code>.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     */
    public CompareToBuilder append(double lhs, double rhs) {
        if (comparison != 0) {
            return this;
        }
        comparison = NumberUtils.compare(lhs, rhs);
        return this;
    }

    /**
     * 2つの <code>float</code> の値の大きさ(&lt;、&gt;、==)を評価します。
     * これは NaN、無限大、-0.0 をハンドルします。
     * これは <code>HashCodeBuilder</code> によって生成されたハッシュコードと互換性を持ちます。
     * {@primary Test if two <code>double</code>s are <, > or ==. This handles NaNs, 
     * Infinties, and -0.0. It is compatible with the hash code generated by 
     * <code>HashCodeBuilder</code>.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     */
    public CompareToBuilder append(float lhs, float rhs) {
        if (comparison != 0) {
            return this;
        }
        comparison = NumberUtils.compare(lhs, rhs);
        return this;
    }

    /**
     * 2つの <code>boolean</code> の値の大きさ(&lt;、&gt;、==)を評価します。
     * {@primary Test if two <code>boolean</code>s are &lt;, &gt; or ==.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
      */
    public CompareToBuilder append(boolean lhs, boolean rhs) {
        if (comparison != 0) {
            return this;
        }
        if (lhs == rhs) {
            return this;
        }
        if (lhs == false) {
            comparison = -1;
        } else {
            comparison = +1;
        }
        return this;
    }

    /**
     * 2つのオブジェクトの配列の内容を掘り下げて比較を行います。
     * また、このメソッドは多次元配列、不完全な配列(訳注 ragged を無理やり訳しました)、複数の型の配列の比較の際にも呼ばれます。
     * もし2つの配列の長さが違って短い方の配列の内容が長い方の配列の(その長さまでの)内容と等しい場合、
     * 長い方の配列が大きいと判断されます。
     * これは辞書または語彙の順番付けの方法です。
     * {@primary Performs a deep comparison of two object arrays. This also will be
     * called for the top level of multi-dimensional, ragged, and multi-typed
     * arrays. If two arrays are of different lengths, and all elements of the
     * shorter array are equal to the elements in the longer array, the longer
     * array is the greater. This is dictionary, or lexical, ordering.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     * @throws NullPointerException  どちらか片方の引数が null の場合
     * {@primary if either (but not both) parameter is null}
     * @throws ClassCastException  指定され比較対照となるオブジェクトの型が異なる場合
     * {@primary if the specified object's type prevents it from being compared to this Object.}
     */
    public CompareToBuilder append(Object[] lhs, Object[] rhs) {
        if (comparison != 0) {
            return this;
        }
        if (lhs == rhs) {
            return this;
        }
        if (lhs == null || rhs == null) {
            throw new NullPointerException();
        }

        int length = (lhs.length < rhs.length) ? lhs.length : rhs.length;
        for (int i = 0; i < length && comparison == 0; ++i) {
            Class lhsClass = lhs[i].getClass();
            if (!lhsClass.isInstance(rhs[i])) {
                throw new ClassCastException();
            }
            append(lhs[i], rhs[i]);
        }
        if (comparison == 0 && lhs.length != rhs.length) {
            comparison = (lhs.length < rhs.length) ? -1 : +1;
        }
        return this;
    }

    /**
     * <code>long</code> の配列の長さと含まれる全ての値を比較します。
     *  このメソッドは append(long, long) を利用します。
     * {@primary Deep comparison of array of <code>long</code> Length and all values
     *  are compared. The method append(long, long) is used.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     * @throws NullPointerException  どちらか片方の引数が null の場合
     * {@primary if either (but not both) parameter is null}
     */
    public CompareToBuilder append(long[] lhs, long[] rhs) {
        if (comparison != 0) {
            return this;
        }
        if (lhs == rhs) {
            return this;
        }
        if (lhs == null || rhs == null) {
            throw new NullPointerException();
        }
        int length = (lhs.length < rhs.length) ? lhs.length : rhs.length;
        for (int i = 0; i < length && comparison == 0; ++i) {
            append(lhs[i], rhs[i]);
        }
        if (comparison == 0 && lhs.length != rhs.length) {
            comparison = (lhs.length < rhs.length) ? -1 : +1;
        }
        return this;
    }

    /**
     * <code>int</code> の配列の長さと含まれる全ての値を比較します。
     *  このメソッドは append(int, int) を利用します。
     * {@primary Deep comparison of array of <code>int</code> Length and all values
     *  are compared. The method append(int, int) is used.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     * @throws NullPointerException  どちらか片方の引数が null の場合
     * {@primary if either (but not both) parameter is null}
     */
    public CompareToBuilder append(int[] lhs, int[] rhs) {
        if (comparison != 0) {
            return this;
        }
        if (lhs == rhs) {
            return this;
        }
        if (lhs == null || rhs == null) {
            throw new NullPointerException();
        }
        int length = (lhs.length < rhs.length) ? lhs.length : rhs.length;
        for (int i = 0; i < length && comparison == 0; ++i) {
            append(lhs[i], rhs[i]);
        }
        if (comparison == 0 && lhs.length != rhs.length) {
            comparison = (lhs.length < rhs.length) ? -1 : +1;
        }
        return this;
    }

    /**
     * <code>short</code> の配列の長さと含まれる全ての値を比較します。
     *  このメソッドは append(short, short) を利用します。
     * {@primary Deep comparison of array of <code>short</code> Length and all values
     *  are compared. The method append(short, short) is used.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     * @throws NullPointerException  どちらか片方の引数が null の場合
     * {@primary if either (but not both) parameter is null}
     */
    public CompareToBuilder append(short[] lhs, short[] rhs) {
        if (comparison != 0) {
            return this;
        }
        if (lhs == rhs) {
            return this;
        }
        if (lhs == null || rhs == null) {
            throw new NullPointerException();
        }
        int length = (lhs.length < rhs.length) ? lhs.length : rhs.length;
        for (int i = 0; i < length && comparison == 0; ++i) {
            append(lhs[i], rhs[i]);
        }
        if (comparison == 0 && lhs.length != rhs.length) {
            comparison = (lhs.length < rhs.length) ? -1 : +1;
        }
        return this;
    }

    /**
     * <code>char</code> の配列の長さと含まれる全ての値を比較します。
     *  このメソッドは append(char, char) を利用します。
     * {@primary Deep comparison of array of <code>char</code> Length and all values
     *  are compared. The method append(char, char) is used.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     * @throws NullPointerException  どちらか片方の引数が null の場合
     * {@primary if either (but not both) parameter is null}
     */
    public CompareToBuilder append(char[] lhs, char[] rhs) {
        if (comparison != 0) {
            return this;
        }
        if (lhs == rhs) {
            return this;
        }
        if (lhs == null || rhs == null) {
            throw new NullPointerException();
        }
        int length = (lhs.length < rhs.length) ? lhs.length : rhs.length;
        for (int i = 0; i < length && comparison == 0; ++i) {
            append(lhs[i], rhs[i]);
        }
        if (comparison == 0 && lhs.length != rhs.length) {
            comparison = (lhs.length < rhs.length) ? -1 : +1;
        }
        return this;
    }

    /**
     * <code>byte</code> の配列の長さと含まれる全ての値を比較します。
     *  このメソッドは append(byte, byte) を利用します。
     * {@primary Deep comparison of array of <code>byte</code> Length and all values
     *  are compared. The method append(byte, byte) is used.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     * @throws NullPointerException  どちらか片方の引数が null の場合
     * {@primary if either (but not both) parameter is null}
     */
    public CompareToBuilder append(byte[] lhs, byte[] rhs) {
        if (comparison != 0) {
            return this;
        }
        if (lhs == rhs) {
            return this;
        }
        if (lhs == null || rhs == null) {
            throw new NullPointerException();
        }
        int length = (lhs.length < rhs.length) ? lhs.length : rhs.length;
        for (int i = 0; i < length && comparison == 0; ++i) {
            append(lhs[i], rhs[i]);
        }
        if (comparison == 0 && lhs.length != rhs.length) {
            comparison = (lhs.length < rhs.length) ? -1 : +1;
        }
        return this;
    }

    /**
     * <code>double</code> の配列の長さと含まれる全ての値を比較します。
     *  このメソッドは append(double, double) を利用します。
     * {@primary Deep comparison of array of <code>double</code> Length and all values
     *  are compared. The method append(double, double) is used.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     * @throws NullPointerException  どちらか片方の引数が null の場合
     * {@primary if either (but not both) parameter is null}
     */
    public CompareToBuilder append(double[] lhs, double[] rhs) {
        if (comparison != 0) {
            return this;
        }
        if (lhs == rhs) {
            return this;
        }
        if (lhs == null || rhs == null) {
            throw new NullPointerException();
        }
        int length = (lhs.length < rhs.length) ? lhs.length : rhs.length;
        for (int i = 0; i < length && comparison == 0; ++i) {
            append(lhs[i], rhs[i]);
        }
        if (comparison == 0 && lhs.length != rhs.length) {
            comparison = (lhs.length < rhs.length) ? -1 : +1;
        }
        return this;
    }

    /**
     * <code>float</code> の配列の長さと含まれる全ての値を比較します。
     *  このメソッドは append(float, float) を利用します。
     * {@primary Deep comparison of array of <code>float</code> Length and all values
     *  are compared. The method append(float, float) is used.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     * @throws NullPointerException  どちらか片方の引数が null の場合
     * {@primary if either (but not both) parameter is null}
     */
    public CompareToBuilder append(float[] lhs, float[] rhs) {
        if (comparison != 0) {
            return this;
        }
        if (lhs == rhs) {
            return this;
        }
        if (lhs == null || rhs == null) {
            throw new NullPointerException();
        }
        int length = (lhs.length < rhs.length) ? lhs.length : rhs.length;
        for (int i = 0; i < length && comparison == 0; ++i) {
            append(lhs[i], rhs[i]);
        }
        if (comparison == 0 && lhs.length != rhs.length) {
            comparison = (lhs.length < rhs.length) ? -1 : +1;
        }
        return this;
    }

    /**
     * <code>boolean</code> の配列の長さと含まれる全ての値を比較します。
     *  このメソッドは append(boolean, boolean) を利用します。
     * {@primary Deep comparison of array of <code>boolean</code> Length and all values
     *  are compared. The method append(boolean, boolean) is used.}
     * @param lhs  左側
     * {@primary Left Hand Side}
     * @param rhs  右側
     * {@primary Right Hand Side}
     * @return 連結してコールするために使用される CompareToBuilder
     * {@primary CompareToBuilder - used to chain calls.}
     * @throws NullPointerException  どちらか片方の引数が null の場合
     * {@primary if either (but not both) parameter is null}
     */
    public CompareToBuilder append(boolean[] lhs, boolean[] rhs) {
        if (comparison != 0) {
            return this;
        }
        if (lhs == rhs) {
            return this;
        }
        if (lhs == null || rhs == null) {
            throw new NullPointerException();
        }
        int length = (lhs.length < rhs.length) ? lhs.length : rhs.length;
        for (int i = 0; i < length && comparison == 0; ++i) {
            append(lhs[i], rhs[i]);
        }
        if (comparison == 0 && lhs.length != rhs.length) {
            comparison = (lhs.length < rhs.length) ? -1 : +1;
        }
        return this;
    }

    /**
     * より小さい場合にはマイナスのint値、大きい場合にはプラスのint値、等しい場合には0を返します。
     * {@primary Return a negative integer if the object is less than, a positive 
     * integer if the object is greater than, or 0 if the object is equal.}
     * 
     * @return このオブジェクトの方が小さい場合マイナスの値、等しい場合0、大きい場合プラスの値
     * {@primary a negative integer, zero, or a positive integer as this 
     * object is less than, equal to, or greater than the specified object.}
     */
    public int toComparison() {
        return comparison;
    }

}