1 /**
2 * This file Copyright (c) 2014-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 /**
42 * Use a DefinitionMetadata type {name, type, moduleID, location}, with an asString() method that outputs the current format.
43 * Location is the path in the case of a configured item, but could be a class name for cbc, for example.
44 *
45 */
46 public interface DefinitionMetadata extends DefinitionReference {
47
48 DefinitionType getType();
49
50 /**
51 * This is the String that can be used to refer to this definition by ID, e.g as passed to {@link Registry#getProvider(String)}.
52 *
53 * @see Registry#newMetadataBuilder() deprecation commentaries which are relevant to this method
54 */
55 String getReferenceId();
56
57 /**
58 * Location of the object that defines the attached definition; depends on the {@link info.magnolia.config.source.ConfigurationSource ConfigurationSource}.
59 */
60 String getLocation();
61
62 /**
63 * Returns the {@link ConfigurationSourceType type of the configuration source} which initially produced the
64 * definition.
65 */
66 ConfigurationSourceType getConfigurationSourceType();
67
68 default Optional<Deprecation> getDeprecation() {
69 return Optional.empty();
70 }
71 }