StringLengthComparator.java

/*
 *  Copyright 2012 Eric F. Savage, code@efsavage.com
 *
 *   Licensed 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 com.ajah.util.compare;

import java.util.Comparator;

import com.ajah.util.StringUtils;

/**
 * Compares a String based on its length, using {@link String#compareTo(String)}
 * as a tiebreaker.
 * 
 * @author <a href="http://efsavage.com">Eric F. Savage</a>, <a
 *         href="mailto:code@efsavage.com">code@efsavage.com</a>.
 */
public class StringLengthComparator implements Comparator<String> {

	/*
	 * (non-Javadoc)
	 * 
	 * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
	 */
	@Override
	public int compare(final String first, final String second) {
		int retVal = CompareUtils.compare(StringUtils.isBlank(first), StringUtils.isBlank(second));
		if (retVal == 0) {
			retVal = CompareUtils.compareNulls(first, second);
		}
		if (retVal == 0) {
			retVal = CompareUtils.compare(first.length(), second.length());
		}
		if (retVal == 0) {
			return first.compareTo(second);
		}
		return retVal;
	}

}