forked from Knotx/knotx
/
Fragment.java
188 lines (163 loc) · 5.44 KB
/
Fragment.java
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
/*
* Copyright (C) 2016 Cognifide Limited
*
* 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 io.knotx.dataobjects;
import com.google.common.base.Objects;
import io.vertx.codegen.annotations.DataObject;
import io.vertx.core.json.JsonArray;
import io.vertx.core.json.JsonObject;
import java.util.Collections;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.stream.Collectors;
import org.apache.commons.lang3.StringUtils;
/**
* An entity representing a markup slice produced during Template fragmentation. It represents both
* markup with static and dynamic content.
*/
@DataObject(inheritConverter = true)
public class Fragment {
private static final String RAW_FRAGMENT_ID = "_raw";
private static final String KNOTS_KEY = "_KNOTS";
private static final String CONTENT_KEY = "_CONTENT";
private static final String CONTEXT_KEY = "_CONTEXT";
private static final String FAILED_KEY = "_FAILED";
private static final String FAILURE_DETAILS_KEY = "_FAILEURE_DETAILS";
private static final String FALLBACK_KEY = "_FALLBACK";
private final List<String> knots;
private final JsonObject context;
private String content;
private boolean failed;
private String failureDetails;
private String fallback;
public Fragment(JsonObject fragment) {
this.knots = fragment.getJsonArray(KNOTS_KEY).stream().map(String::valueOf)
.collect(Collectors.toList());
this.content = fragment.getString(CONTENT_KEY);
this.context = fragment.getJsonObject(CONTEXT_KEY, new JsonObject());
this.failed = fragment.getBoolean(FAILED_KEY);
this.failureDetails = fragment.getString(FAILURE_DETAILS_KEY);
this.fallback = fragment.getString(FALLBACK_KEY);
}
private Fragment(List<String> knots, String data, String fallback) {
if (knots == null || knots.isEmpty() || StringUtils.isEmpty(data)) {
throw new NoSuchElementException("Fragment is not valid [" + knots + "], [" + data + "].");
}
this.knots = knots;
this.content = data;
this.context = new JsonObject();
this.fallback = fallback;
}
public static Fragment raw(String data) {
return new Fragment(Collections.singletonList(RAW_FRAGMENT_ID), data, null);
}
public static Fragment snippet(List<String> knots, String data, String fallback) {
return new Fragment(knots, data, fallback);
}
public static Fragment snippet(List<String> knots, String data) {
return snippet(knots, data,null);
}
public JsonObject toJson() {
return new JsonObject().put(KNOTS_KEY, new JsonArray(knots)).put(CONTENT_KEY, content)
.put(CONTEXT_KEY, context)
.put(FAILED_KEY, failed)
.put(FAILURE_DETAILS_KEY, failureDetails)
.put(FALLBACK_KEY, fallback);
}
/**
* @return list of Knots identifiers that are used during Knot usage decision.
*/
public List<String> knots() {
return knots;
}
/**
* @return markup content of this fragment.
*/
public String content() {
return content;
}
public Fragment content(String content) {
this.content = content;
return this;
}
/**
* @return a {@link JsonObject} containing the data produced during Knots chain processing and
* used to exchange the context between them, e.g. ActionKnot can put there `action` context that
* contains data accumulated during action processing.
*/
public JsonObject context() {
return context;
}
/**
* @return <tt>true</tt> if this Fragment has no dynamic parts (contains only static markup).
*/
public boolean isRaw() {
return knots.contains(RAW_FRAGMENT_ID);
}
/**
* @return true if processing of this Fragment has failed
*/
public boolean failed() {
return failed;
}
/**
* @return replacement markup that should be rendered if this Fragment has failed. Can be empty
* string. Null value indicates that no replacement markup is provided.
*/
public String fallback() {
return fallback;
}
/**
* @return failure details for this Fragment
*/
public String failureDetails() {
return failureDetails;
}
public Fragment failed(boolean failed) {
this.failed = failed;
return this;
}
public Fragment failureDetails(String failureDetails) {
this.failureDetails = failureDetails;
return this;
}
public boolean hasFallback() {
return fallback != null;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof Fragment)) {
return false;
}
Fragment that = (Fragment) o;
return Objects.equal(knots, that.knots) &&
Objects.equal(content, that.content) &&
Objects.equal(context, that.context) &&
Objects.equal(failed, that.failed) &&
Objects.equal(failureDetails, that.failureDetails) &&
Objects.equal(fallback, that.fallback);
}
@Override
public int hashCode() {
return Objects.hashCode(knots, content, context);
}
@Override
public String toString() {
return toJson().toString();
}
}