summaryrefslogtreecommitdiff
path: root/src/main/java/com/keuin/kbackupfabric/operation/abstracts/AbstractSerialOperation.java
blob: 92dfb536e47a2a67cf92ffa52b2b694bfd9135e0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
package com.keuin.kbackupfabric.operation.abstracts;

/**
 * The most basic operation abstraction.
 * This class represents an serial operation, which is limited in a non-public method.
 * Note that the operation is not invokable by default, you should use InvokableOperation in order to provide a public method for users to call.
 */
public abstract class AbstractSerialOperation {
    /**
     * Do your operation here.
     * This method is not designed to be public.
     * When this method returns, the operation must have been finished.
     *
     * @return whether the operation succeed.
     */
    protected abstract boolean operate();
}