View Javadoc
1   /**
2    * This file Copyright (c) 2015-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.registry;
35  
36  import info.magnolia.config.source.Deprecation;
37  import info.magnolia.config.source.ConfigurationSourceType;
38  
39  import java.util.Optional;
40  
41  import lombok.AllArgsConstructor;
42  import lombok.Getter;
43  import lombok.Value;
44  
45  /**
46   * DefinitionMetadataBuilder are used to progressively populate metadata for a {@link DefinitionProvider}. For example,
47   * the name() method could be called several times before a provider is registered in a {@link info.magnolia.config.registry.Registry}.
48   * They are also responsible for determining the referenceId string used by the registries. Implement your own, or use
49   * one of the static factory methods.
50   * @see #usingModuleAndRelativePathAsId()
51   * @see #usingNameAsId()
52   */
53  @Getter
54  public abstract class DefinitionMetadataBuilder {
55      /**
56       * A convenience static factory method which returns a DefinitionMetadataBuilder which generates referenceId using the <module-name>:<relative-location> form.
57       */
58      public static DefinitionMetadataBuilder usingModuleAndRelativePathAsId() {
59          return new ModuleAndRelativePathMetadataBuilder();
60      }
61  
62      /**
63       * A convenience static factory method which returns a DefinitionMetadataBuilder which generates referenceId using the name property.
64       */
65      public static DefinitionMetadataBuilder usingNameAsId() {
66          return new NameMetadataBuilder();
67      }
68  
69      private static class ModuleAndRelativePathMetadataBuilder extends DefinitionMetadataBuilder {
70          @Override
71          protected String buildReferenceId() {
72              return getModule() + ":" + getRelativeLocation();
73          }
74      }
75  
76      private static class NameMetadataBuilder extends DefinitionMetadataBuilder {
77          @Override
78          protected String buildReferenceId() {
79              return getName();
80          }
81      }
82  
83      private DefinitionType type;
84      private String name;
85      private String module;
86      private String location;
87      private String relativeLocation;
88      private ConfigurationSourceType configurationSourceType;
89      private Deprecation deprecation;
90  
91      protected DefinitionMetadataBuilder() {
92      }
93  
94      public DefinitionMetadataBuilder type(DefinitionType type) {
95          this.type = type;
96          return this;
97      }
98  
99      public DefinitionMetadataBuilder name(String name) {
100         this.name = name;
101         return this;
102     }
103 
104     public DefinitionMetadataBuilder module(String module) {
105         this.module = module;
106         return this;
107     }
108 
109     public DefinitionMetadataBuilder location(String location) {
110         this.location = location;
111         return this;
112     }
113 
114     public DefinitionMetadataBuilder relativeLocation(String relativeLocation) {
115         this.relativeLocation = relativeLocation;
116         return this;
117     }
118 
119     public DefinitionMetadataBuilder configurationSourceType(ConfigurationSourceType configurationSourceType) {
120         this.configurationSourceType = configurationSourceType;
121         return this;
122     }
123 
124     public DefinitionMetadataBuilder deprecation(Deprecation deprecation) {
125         this.deprecation = deprecation;
126         return this;
127     }
128 
129     public DefinitionMetadata build() {
130         final String referenceId = buildReferenceId();
131         return new DefinitionMetadataImpl(this.type, referenceId, this.name, this.module, this.location, this.relativeLocation,
132                 this.configurationSourceType, this.deprecation);
133     }
134 
135     protected abstract String buildReferenceId();
136 
137     /**
138      * Implementation of {@link info.magnolia.config.registry.DefinitionMetadata}.
139      */
140     @Value
141     @AllArgsConstructor
142     public static class DefinitionMetadataImpl implements DefinitionMetadata {
143         private final DefinitionType type;
144         private final String referenceId;
145         private final String name;
146         private final String module;
147         private final String location;
148         private final String relativeLocation;
149         private final ConfigurationSourceType configurationSourceType;
150         private final Deprecation deprecation;
151 
152         @Override
153         public String toString() {
154             String metadataString = String.format("[%s] definition [%s] with reference id: [%s] from module [%s] at [%s]",
155                     type.getName(), name, referenceId, module, relativeLocation);
156             if (deprecation != null) {
157                 metadataString += metadataString + String.format(" which is deprecated %s", deprecation);
158             }
159             return metadataString;
160         }
161 
162         public Optional<Deprecation> getDeprecation() {
163             return Optional.ofNullable(deprecation);
164         }
165     }
166 
167 }