org.eclipse.debug.tests/src/org/eclipe/debug/tests/viewer/model/TreePathWrapper.java

/*******************************************************************************
 * Copyright (c) 2011 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipe.debug.tests.viewer.model;

import junit.framework.Assert;

import org.eclipse.jface.viewers.TreePath;

/**
 * Utility for comparing TreePath objects in unit tests.  This wrapper prints the tree 
 * paths in exception showing contexts of the paths.
 * 
 * @since 3.7
 */
public class TreePathWrapper {
    private final TreePath fPath;

    public TreePathWrapper(TreePath path) {
        fPath = path;
    }
    
    public int hashCode() {
        return fPath.hashCode();
    }
    
    public boolean equals(Object obj) {
        return obj instanceof TreePathWrapper &&
               fPath.equals( ((TreePathWrapper)obj).fPath ); 
    }
    
    public String toString() {
        if (fPath.getSegmentCount() == 0) {
            return "TreePath:EMPTY";
        }
        
        StringBuffer buf = new StringBuffer("TreePath:[");
        
        for (int i = 0; i < fPath.getSegmentCount(); i++) {
            if (i != 0) {
                buf.append(", ");                    
            }
            buf.append(fPath.getSegment(i));
        }
        buf.append(']');
        return buf.toString();
    }
    
    /**
     * Asserts that the two given tree paths are the same.  In case of failure, the 
     * generated exception will contain a printout of the tree paths' contents.
     */
    public static void assertEqual(TreePath expected, TreePath actual) {
        Assert.assertEquals(
            expected != null ? new TreePathWrapper(expected) : null,  
            actual != null ? new TreePathWrapper(actual) : null);
    }        
}