/*
 * ====================================================================
 * Copyright (c) 2004-2012 TMate Software Ltd.  All rights reserved.
 *
 * This software is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at http://svnkit.com/license.html
 * If newer versions of this license are posted there, you may use a
 * newer version instead, at your option.
 * ====================================================================
 */
package org.tmatesoft.svn.core.wc;

import org.tmatesoft.svn.core.SVNException;

/**
 * The <b>ISVNStatusHandler</b> interface should be implemented in order to
 * be further provided to some of <b>SVNStatusClient</b>'s doStatus() methods
 * to handle status information of Working Copy items. 
 * 
 * <p>
 * When running a status operation using a status handler an 
 * <b>SVNStatusClient</b>'s doStatus() method generates an <b>SVNStatus</b>
 * object per each interesting WC entry and dispatches that object to the
 * status handler where it's up to a developer to retrieve status detailes   
 * from the <b>SVNStatus</b> object and interprete them in a desired way.
 * 
 * <p>
 * All calls to a <b>handleStatus()</b> method are synchronous - that is the
 * caller is blocked till the method finishes.
 *  
 * @version 1.3
 * @author  TMate Software Ltd.
 * @since   1.2
 * @see     SVNStatusClient
 * @see     SVNStatus
 * @see     <a target="_top" href="http://svnkit.com/kb/examples/">Examples</a>
 * 
 */
public interface ISVNStatusHandler {
    /**
     * Handles WC item's status information using an <b>SVNStatus</b> object.
     * 
     * @param status  an object that contains per item status information
     * @throws SVNException
     */
    public void handleStatus(SVNStatus status) throws SVNException;
}
