source: trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInstanceList.java @ 1177

Last change on this file since 1177 was 1177, checked in by pharms, 11 years ago
  • improved java doc
File size: 1.8 KB
Line 
1//   Copyright 2012 Georg-August-Universität Göttingen, Germany
2//
3//   Licensed under the Apache License, Version 2.0 (the "License");
4//   you may not use this file except in compliance with the License.
5//   You may obtain a copy of the License at
6//
7//       http://www.apache.org/licenses/LICENSE-2.0
8//
9//   Unless required by applicable law or agreed to in writing, software
10//   distributed under the License is distributed on an "AS IS" BASIS,
11//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//   See the License for the specific language governing permissions and
13//   limitations under the License.
14
15package de.ugoe.cs.autoquest.tasktrees.treeifc;
16
17import java.io.Serializable;
18
19/**
20 * <p>
21 * represents a serializable, clonable, iterable representation of a read only list of task
22 * instances. The list is ordered. It does not provide methods for changing it.
23 * </p>
24 *
25 * @author Patrick Harms
26 */
27public interface ITaskInstanceList extends Serializable, Cloneable, Iterable<ITaskInstance> {
28
29    /**
30     * <p>
31     * returns the task instance at the position with the given index. May throw an exception
32     * if the index is invalid.
33     * </p>
34     *
35     * @param index the index of the task instance to be returned
36     *
37     * @return the task instance at the given index
38     */
39    public ITaskInstance get(int index);
40
41    /**
42     * <p>
43     * returns the size of the list, i.e. the number of task instances in the list
44     * </p>
45     *
46     * @return as described
47     */
48    public int size();
49
50    /**
51     * <p>
52     * clones a task instance list by creating exact clones of each contained instance in their
53     * order
54     * </p>
55     *
56     * @return a clone of the task instance list
57     */
58    public ITaskInstanceList clone();
59 
60}
Note: See TracBrowser for help on using the repository browser.