< prev index next >

bot/src/main/java/org/openjdk/skara/bot/BotConfiguration.java

Print this page

 8  *
 9  * This code is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * version 2 for more details (a copy is included in the LICENSE file that
13  * accompanied this code).
14  *
15  * You should have received a copy of the GNU General Public License version
16  * 2 along with this work; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18  *
19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20  * or visit www.oracle.com if you need additional information or have any
21  * questions.
22  */
23 package org.openjdk.skara.bot;
24 
25 import org.openjdk.skara.census.Census;
26 import org.openjdk.skara.host.HostedRepository;
27 import org.openjdk.skara.json.JSONObject;

28 
29 import java.nio.file.Path;
30 import java.util.Optional;
31 
32 public interface BotConfiguration {
33 
34     /**
35      * Folder that WorkItems may use to store permanent data.
36      * @return
37      */
38     Path storageFolder();
39 
40     /**
41      * Configuration-specific name mapped to a HostedRepository.
42      * @param name
43      * @return
44      */
45     HostedRepository repository(String name);
46 








47     /**
48      * Additional bot-specific configuration.
49      * @return
50      */
51     JSONObject specific();
52 }

 8  *
 9  * This code is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * version 2 for more details (a copy is included in the LICENSE file that
13  * accompanied this code).
14  *
15  * You should have received a copy of the GNU General Public License version
16  * 2 along with this work; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18  *
19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20  * or visit www.oracle.com if you need additional information or have any
21  * questions.
22  */
23 package org.openjdk.skara.bot;
24 
25 import org.openjdk.skara.census.Census;
26 import org.openjdk.skara.host.HostedRepository;
27 import org.openjdk.skara.json.JSONObject;
28 import org.openjdk.skara.vcs.Branch;
29 
30 import java.nio.file.Path;
31 import java.util.Optional;
32 
33 public interface BotConfiguration {

34     /**
35      * Folder that WorkItems may use to store permanent data.
36      * @return
37      */
38     Path storageFolder();
39 
40     /**
41      * Configuration-specific name mapped to a HostedRepository.
42      * @param name
43      * @return
44      */
45     HostedRepository repository(String name);
46 
47     /**
48      * Retrieves the ref name that optionally follows the configuration-specific repository name.
49      * If not configured, returns the name of the VCS default branch.
50      * @param name
51      * @return
52      */
53     String repositoryRef(String name);
54 
55     /**
56      * Additional bot-specific configuration.
57      * @return
58      */
59     JSONObject specific();
60 }
< prev index next >