1 /**
2 * This file Copyright (c) 2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.config.source.yaml.construct;
35
36 import static info.magnolia.config.maputil.ToMap.toMap;
37
38 import info.magnolia.config.maputil.ToMap;
39 import info.magnolia.config.registry.DefinitionProvider;
40
41 import java.util.AbstractMap;
42 import java.util.Map;
43 import java.util.Set;
44 import java.util.function.Consumer;
45
46 import org.yaml.snakeyaml.nodes.Node;
47
48 /**
49 * Custom {@link org.yaml.snakeyaml.constructor.Construct construct} bound to <b>!metadata</b> tag.
50 *
51 * <p>
52 * It simply wraps given yaml node into {@link Metadata} object which later will be processed by
53 * {@link info.magnolia.config.source.yaml.MetadataProcessor}.
54 * </p>
55 */
56 public class WrapMetadata extends MgnlYamlConstruct {
57
58 public static final String TAG_PREFIX = "!metadata";
59
60 public WrapMetadata(Consumer<DefinitionProvider.Problem> problemCollector) {
61 super(problemCollector);
62 }
63
64 @Override
65 public Object construct(Node node) {
66 return new Metadata(toMap(getConstructor().getConstructByNodeType(node).construct(node)));
67 }
68
69 /**
70 * Simple Map to present Metadata objects.
71 */
72 public final static class Metadata extends AbstractMap<String, Object> {
73
74 private final Map<String, Object> wrappedMap;
75
76 public Metadata(Map<String, Object> wrappedMap) {
77 this.wrappedMap = wrappedMap;
78 }
79
80 public static Metadata of(Object source) {
81 return source instanceof Metadata ? (Metadata) source : new Metadata(ToMap.toMap(source));
82 }
83
84 @Override
85 public Set<Entry<String, Object>> entrySet() {
86 return this.wrappedMap.entrySet();
87 }
88 }
89 }