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
|
/*
* Copyright (C) 2010 The Android Open Source Project
*
* Licensed 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 com.android.layoutlib.api;
/**
* Scene result class.
*/
public class SceneResult {
private final SceneStatus mStatus;
private final String mErrorMessage;
private final Throwable mThrowable;
private Object mData;
public enum SceneStatus {
SUCCESS,
NOT_IMPLEMENTED,
ERROR_TIMEOUT,
ERROR_LOCK_INTERRUPTED,
ERROR_INFLATION,
ERROR_VIEWGROUP_NO_CHILDREN,
ERROR_NOT_INFLATED,
ERROR_RENDER,
ERROR_ANIM_NOT_FOUND,
ERROR_UNKNOWN;
/**
* Returns a {@link SceneResult} object with this status.
* @return an instance of SceneResult;
*/
public SceneResult getResult() {
// don't want to get generic error that way.
assert this != ERROR_UNKNOWN;
return new SceneResult(this);
}
}
/**
* Creates a {@link SceneResult} object with the given SceneStatus.
*
* @param status the status. Must not be null.
*/
public SceneResult(SceneStatus status) {
this(status, null, null);
}
/**
* Creates a {@link SceneResult} object with the given SceneStatus, and the given message
* and {@link Throwable}.
*
* @param status the status. Must not be null.
* @param errorMessage an optional error message.
*/
public SceneResult(SceneStatus status, String errorMessage) {
this(status, errorMessage, null);
}
/**
* Creates a {@link SceneResult} object with the given SceneStatus, and the given message
* and {@link Throwable}
*
* @param status the status. Must not be null.
* @param errorMessage an optional error message.
* @param t an optional exception.
*/
public SceneResult(SceneStatus status, String errorMessage, Throwable t) {
assert status != null;
mStatus = status;
mErrorMessage = errorMessage;
mThrowable = t;
}
/**
* Returns whether the status is successful.
* <p>
* This is the same as calling <code>getStatus() == SceneStatus.SUCCESS</code>
* @return <code>true</code> if the status is successful.
*/
public boolean isSuccess() {
return mStatus == SceneStatus.SUCCESS;
}
/**
* Returns the status. This is never null.
*/
public SceneStatus getStatus() {
return mStatus;
}
/**
* Returns the error message. This is only non-null when {@link #getStatus()} returns
* {@link SceneStatus#ERROR_UNKNOWN}
*/
public String getErrorMessage() {
return mErrorMessage;
}
/**
* Returns the exception. This is only non-null when {@link #getStatus()} returns
* {@link SceneStatus#ERROR_UNKNOWN}
*/
public Throwable getException() {
return mThrowable;
}
/**
* Sets an optional data bundle in the result object.
* @param data the data bundle
*/
public void setData(Object data) {
mData = data;
}
/**
* Returns the optional data bundle stored in the result object.
* @return the data bundle or <code>null</code> if none have been set.
*/
public Object getData() {
return mData;
}
}
|
