summaryrefslogtreecommitdiffstats
path: root/sca-java-2.x/tags/2.0.1-RC1/modules/core/src/main/java/org/apache/tuscany/sca/core/work/impl/WorkItem.java
blob: 0fc104d0fc40804d715f52f254bfa8a3dac73f7c (plain)
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.    
 */
package org.apache.tuscany.sca.core.work.impl;

import org.apache.tuscany.sca.work.WorkSchedulerException;

/**
 * An identity based immutable implementation of the <code>WorkItem</code>
 * interface.
 *
 * @version $Rev$ $Date$
 */
class WorkItem {
    
    // Id scoped for the VM
    private String id;

    // Status
    private int status = -1;

    // Result
    private Work<?> result;
    
    // Original work
    private Work<?> originalWork;

    // Exception
    private WorkSchedulerException exception;

    /**
     * Instantiates an id for this item.
     *
     * @param id of this work event.
     */
    protected WorkItem(final String id, final Work<?> orginalWork) {
        this.id = id;
        this.originalWork = orginalWork;
    }

    /**
     * Returns the id.
     *
     * @return Id of this item.
     */
    public String getId() {
        return id;
    }

    /**
     * Returns the original work.
     *
     * @return Original work.
     */
    public Work<?> getOriginalWork() {
        return originalWork;
    }

    /**
     * Returns the work result if the work completed.
     *
     * @return Work.
     * @throws WorkException If the work completed with an exception.
     */
    public Work<?> getResult() {
        return result;
    }

    /**
     * Sets the result.
     *
     * @param result Result.
     */
    protected void setResult(final Work<?> result) {
        this.result = result;
    }

    /**
     * Returns the exception if work completed with an exception.
     *
     * @return Work exception.
     */
    protected WorkSchedulerException getException() {
        return exception;
    }

    /**
     * Sets the exception.
     *
     * @param exception Exception.
     */
    protected void setException(final WorkSchedulerException exception) {
        this.exception = exception;
    }

    /**
     * Returns the work type based on whether the work was accepted, started,
     * rejected or completed.
     *
     * @return Work status.
     */
    public int getStatus() {
        return status;
    }

    /**
     * Sets the status.
     *
     * @param status Status.
     */
    protected void setStatus(final int status) {
        this.status = status;
    }

    /**
     * @see Object#hashCode() 
     */
    @Override
    public int hashCode() {
        return id.hashCode();
    }

    /**
     * Indicates whether some other object is "equal to" this one.
     *
     * @param obj Object to be compared.
     * @return true if this object is the same as the obj argument; false
     *         otherwise..
     */
    @Override
    public boolean equals(final Object obj) {
        return (obj != null) && (obj.getClass() == WorkItem.class) && ((WorkItem) obj).id.equals(id);
    }

    /**
     * Compares this object with the specified object for order. Returns a
     * negative integer, zero, or a positive integer as this object is less
     * than, equal to, or greater than the specified object.
     *
     * @param o Object to be compared.
     * @return A negative integer, zero, or a positive integer as this object
     *         is less than, equal to, or greater than the specified object.
     * @throws ClassCastException needs better documentation.
     */
    public int compareTo(final Object o) {
        if (o.getClass() != WorkItem.class) {
            throw new ClassCastException(o.getClass().getName());
        } else {
            return ((WorkItem) o).getId().compareTo(getId());
        }
    }
}