1 /**
2 * This file Copyright (c) 2015-2016 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.registry;
35
36 import lombok.Getter;
37 import lombok.Value;
38
39 /**
40 * DefinitionMetadataBuilder are used to progressively populate metadata for a {@link DefinitionProvider}. For example,
41 * the name() method could be called several times before a provider is registered in a {@link info.magnolia.config.registry.Registry}.
42 * They are also responsible for determining the referenceId string used by the registries. Implement your own, or use
43 * one of the static factory methods.
44 * @see #usingModuleAndRelativePathAsId()
45 * @see #usingNameAsId()
46 */
47 @Getter
48 public abstract class DefinitionMetadataBuilder {
49 /**
50 * A convenience static factory method which returns a DefinitionMetadataBuilder which generates referenceId using the <module-name>:<relative-location> form.
51 */
52 public static DefinitionMetadataBuilder usingModuleAndRelativePathAsId() {
53 return new ModuleAndRelativePathMetadataBuilder();
54 }
55
56 /**
57 * A convenience static factory method which returns a DefinitionMetadataBuilder which generates referenceId using the name property.
58 */
59 public static DefinitionMetadataBuilder usingNameAsId() {
60 return new NameMetadataBuilder();
61 }
62
63 private static class ModuleAndRelativePathMetadataBuilder extends DefinitionMetadataBuilder {
64 @Override
65 protected String buildReferenceId() {
66 return getModule() + ":" + getRelativeLocation();
67 }
68 }
69
70 private static class NameMetadataBuilder extends DefinitionMetadataBuilder {
71 @Override
72 protected String buildReferenceId() {
73 return getName();
74 }
75 }
76
77 private DefinitionType type;
78 private String name;
79 private String module;
80 private String location;
81 private String relativeLocation;
82
83 protected DefinitionMetadataBuilder() {
84 }
85
86 public DefinitionMetadataBuilder type(DefinitionType type) {
87 this.type = type;
88 return this;
89 }
90
91 public DefinitionMetadataBuilder name(String name) {
92 this.name = name;
93 return this;
94 }
95
96 public DefinitionMetadataBuilder module(String module) {
97 this.module = module;
98 return this;
99 }
100
101 public DefinitionMetadataBuilder location(String location) {
102 this.location = location;
103 return this;
104 }
105
106 public DefinitionMetadataBuilder relativeLocation(String relativeLocation) {
107 this.relativeLocation = relativeLocation;
108 return this;
109 }
110
111 public DefinitionMetadata build() {
112 final String referenceId = buildReferenceId();
113 return new DefinitionMetadataImpl(this.type, referenceId, this.name, this.module, this.location, this.relativeLocation);
114 }
115
116 protected abstract String buildReferenceId();
117
118 /**
119 * Implementation of {@link info.magnolia.config.registry.DefinitionMetadata}.
120 */
121 @Value
122 public static class DefinitionMetadataImpl implements DefinitionMetadata {
123 private final DefinitionType type;
124 private final String referenceId;
125 private final String name;
126 private final String module;
127 private final String location;
128 private final String relativeLocation;
129 }
130
131 }