-
Notifications
You must be signed in to change notification settings - Fork 0
/
Step.java
108 lines (95 loc) · 3.45 KB
/
Step.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/**
* Copyright (c) 2017, Mihai Emil Andronache
* All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1)Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2)Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3)Neither the name of comdor nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package co.comdor;
import co.comdor.github.Mention;
import java.io.IOException;
/**
* A step that the bot takes in order to do something.
* @author Mihai Andronache (amihaiemil@gmail.com)
* @version $Id$
* @since 0.0.1
*/
public interface Step {
/**
* Perform this step.
* @param mention Mention that triggered the action.
* @param log The Action's logger.
* @throws IOException If there is anything wrong in the communication
* with Github.
*/
void perform(final Mention mention, final Log log) throws IOException;
/**
* Final step in the chain.
* It logs a line saying the action was successful.
*/
final class FinalStep implements Step {
/**
* Message to log.
*/
private String message;
/**
* Ctor without message for successful ending.
*/
public FinalStep() {
this("Finished action successfully!");
}
/**
* Ctor.
* @param message Message to log at the end of the action.
*/
public FinalStep(final String message) {
this.message = message;
}
@Override
public void perform(final Mention mention, final Log log) {
log.logger().info(this.message);
}
}
/**
* Fake for unit tests.
*/
final class Fake implements Step {
/**
* Should this step's perform pass or throw an exception?
*/
private boolean pass;
/**
* Ctor.
* @param pass Should this step pass or throw an exception?
*/
public Fake(final boolean pass) {
this.pass = pass;
}
@Override
public void perform(final Mention mention, final Log log) {
if(!this.pass) {
throw new IllegalStateException(
"Step should not have been executed!"
);
}
}
}
}