1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.vfs2.operations.vcs;
18
19 import org.apache.commons.vfs2.operations.FileOperation;
20
21 /**
22 * The VCS commit file operation.
23 *
24 * @since 0.1
25 */
26 public interface VcsCommit extends FileOperation {
27
28 /**
29 * Sets the listener that is given control when a commit occurs.
30 *
31 * @param listener Listener that is given control when a commit occurs.
32 */
33 void addCommitListener(VcsCommitListener listener);
34
35 /**
36 * Removes the listener that is given control when a commit occurs.
37 *
38 * @param listener The Listener.
39 */
40 void removeCommitListener(VcsCommitListener listener);
41
42 /**
43 * Sets the message.
44 *
45 * @param message The message.
46 */
47 void setMessage(String message);
48
49 /**
50 * Sets whether directories should be traversed.
51 *
52 * @param isRecursive true if directories should be traversed.
53 */
54 void setRecursive(boolean isRecursive);
55 }