org.tigris.subversion.javahl.Notify Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of svnkit
The only pure Java Subversion library in the world, formerly known as JavaSVN
The newest version!
/**
 * @copyright
 * ====================================================================
 * Copyright (c) 2003-2005 CollabNet.  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://subversion.tigris.org/license-1.html.
 * If newer versions of this license are posted there, you may use a
 * newer version instead, at your option.
 *
 * This software consists of voluntary contributions made by many
 * individuals.  For exact contribution history, see the revision
 * history and logs, available at http://subversion.tigris.org/.
 * ====================================================================
 * @endcopyright
 */
package org.tigris.subversion.javahl;

/**
 * Subversion notification interface.
 *
 * Implement this interface and implement the onNotify method
 * to provide a custom notification handler to the Modify
 * class.
 * If you need to pass extra information to the notification
 * handler then just add these to you implementing class
 * @deprecated Use Notify2 instead
 */
public interface Notify
{
    /**
     * Handler for Subversion notifications.
     *
     * Override this function to allow Subversion to
     * send notifications
     * @param path on which action happen
     * @param action subversion action, see svn_wc_notify_action_t
     * @param kind node kind of path after action occurred
     * @param mimeType mime type of path after action occurred
     * @param contentState state of content after action occurred
     * @param propState state of properties after action occurred
     * @param revision revision number  after action occurred
     */
    public void onNotify(String path, int action, int kind, String mimeType, int contentState, int propState, long revision);

    /**
     * The type of action occuring.
     * The values are defined in the interface NotifyAction for building reasons.
     */
    public static final class Action implements NotifyAction
    {
        /**
         * Returns the textual representation for the action kind
         * @param action kind of action
         * @return english text
         */
		public static final String getActionName(int action)
		{
			return NotifyAction.actionNames[action];
		}

    }
    /**
     * The type of notification that is occuring.
     * The values are defined in the interface NotifyStatus for building reasons.
     */
    public static final class Status implements NotifyStatus
   {
        /**
         * Returns the textual representation for the notification type
         * @param status    type of the notification
         * @return  english text
         */
		public static final String getStatusName(int status)
		{
			return NotifyStatus.statusNames[status];
		}
    }
}