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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/*
* Copyright (c) 2012, the Last.fm Java Project and Committers All rights
* reserved. Redistribution and use of this software in source and binary forms,
* with or without modification, are permitted provided that the following
* conditions are met: - Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following disclaimer. -
* 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. 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 OWNER 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 com.cyanogenmod.eleven.lastfm;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
/**
* This utility class can be used to generically generate Result objects
* (usually Lists or {@link PaginatedResult}s) from an XML response using
* {@link ItemFactory ItemFactories}.
*
* @author Janni Kovacs
*/
public final class ResponseBuilder {
private ResponseBuilder() {
}
/**
* @param <T>
* @param itemClass
* @return
*/
private static <T> ItemFactory<T> getItemFactory(final Class<T> itemClass) {
return ItemFactoryBuilder.getFactoryBuilder().getItemFactory(itemClass);
}
/**
* @param <T>
* @param result
* @param itemClass
* @return
*/
public static <T> Collection<T> buildCollection(final Result result, final Class<T> itemClass) {
return buildCollection(result, getItemFactory(itemClass));
}
/**
* @param <T>
* @param result
* @param factory
* @return
*/
public static <T> Collection<T> buildCollection(final Result result,
final ItemFactory<T> factory) {
if (!result.isSuccessful()) {
return Collections.emptyList();
}
return buildCollection(result.getContentElement(), factory);
}
/**
* @param <T>
* @param element
* @param itemClass
* @return
*/
public static <T> Collection<T> buildCollection(final DomElement element,
final Class<T> itemClass) {
return buildCollection(element, getItemFactory(itemClass));
}
/**
* @param <T>
* @param element
* @param factory
* @return
*/
public static <T> Collection<T> buildCollection(final DomElement element,
final ItemFactory<T> factory) {
if (element == null) {
return Collections.emptyList();
}
final Collection<DomElement> children = element.getChildren();
final Collection<T> items = new ArrayList<T>(children.size());
for (final DomElement child : children) {
items.add(factory.createItemFromElement(child));
}
return items;
}
/**
* @param <T>
* @param result
* @param itemClass
* @return
*/
public static <T> PaginatedResult<T> buildPaginatedResult(final Result result,
final Class<T> itemClass) {
return buildPaginatedResult(result, getItemFactory(itemClass));
}
/**
* @param <T>
* @param result
* @param factory
* @return
*/
public static <T> PaginatedResult<T> buildPaginatedResult(final Result result,
final ItemFactory<T> factory) {
if (result != null) {
if (!result.isSuccessful()) {
return new PaginatedResult<T>(0, 0, Collections.<T> emptyList());
}
final DomElement contentElement = result.getContentElement();
return buildPaginatedResult(contentElement, contentElement, factory);
}
return null;
}
/**
* @param <T>
* @param contentElement
* @param childElement
* @param itemClass
* @return
*/
public static <T> PaginatedResult<T> buildPaginatedResult(final DomElement contentElement,
final DomElement childElement, final Class<T> itemClass) {
return buildPaginatedResult(contentElement, childElement, getItemFactory(itemClass));
}
/**
* @param <T>
* @param contentElement
* @param childElement
* @param factory
* @return
*/
public static <T> PaginatedResult<T> buildPaginatedResult(final DomElement contentElement,
final DomElement childElement, final ItemFactory<T> factory) {
final Collection<T> items = buildCollection(childElement, factory);
String totalPagesAttribute = contentElement.getAttribute("totalPages");
if (totalPagesAttribute == null) {
totalPagesAttribute = contentElement.getAttribute("totalpages");
}
final int page = Integer.parseInt(contentElement.getAttribute("page"));
final int totalPages = Integer.parseInt(totalPagesAttribute);
return new PaginatedResult<T>(page, totalPages, items);
}
/**
* @param <T>
* @param result
* @param itemClass
* @return
*/
public static <T> T buildItem(final Result result, final Class<T> itemClass) {
return buildItem(result, getItemFactory(itemClass));
}
/**
* @param <T>
* @param result
* @param factory
* @return
*/
public static <T> T buildItem(final Result result, final ItemFactory<T> factory) {
if (!result.isSuccessful()) {
return null;
}
return buildItem(result.getContentElement(), factory);
}
/**
* @param <T>
* @param element
* @param itemClass
* @return
*/
public static <T> T buildItem(final DomElement element, final Class<T> itemClass) {
return buildItem(element, getItemFactory(itemClass));
}
/**
* @param <T>
* @param element
* @param factory
* @return
*/
private static <T> T buildItem(final DomElement element, final ItemFactory<T> factory) {
return factory.createItemFromElement(element);
}
}
|
