001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.vfs2.operations.vcs;
018
019import org.apache.commons.vfs2.operations.FileOperation;
020
021/**
022 * The VCS commit file operation.
023 *
024 * @since 0.1
025 */
026public interface VcsCommit extends FileOperation {
027
028    /**
029     * Sets the listener that is given control when a commit occurs.
030     *
031     * @param listener Listener that is given control when a commit occurs.
032     */
033    void addCommitListener(VcsCommitListener listener);
034
035    /**
036     * Removes the listener that is given control when a commit occurs.
037     *
038     * @param listener The Listener.
039     */
040    void removeCommitListener(VcsCommitListener listener);
041
042    /**
043     * Sets the message.
044     *
045     * @param message The message.
046     */
047    void setMessage(String message);
048
049    /**
050     * Sets whether directories should be traversed.
051     *
052     * @param isRecursive true if directories should be traversed.
053     */
054    void setRecursive(boolean isRecursive);
055}