001/*
002 * Copyright 2012-2015 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.configurationmetadata;
018
019import java.util.Map;
020
021/**
022 * A repository of configuration metadata.
023 *
024 * @author Stephane Nicoll
025 * @since 1.3.0
026 */
027public interface ConfigurationMetadataRepository {
028
029        /**
030         * Defines the name of the "root" group, that is the group that gathers all the
031         * properties that aren't attached to a specific group.
032         */
033        String ROOT_GROUP = "_ROOT_GROUP_";
034
035        /**
036         * Return the groups, indexed by id.
037         * @return all configuration meta-data groups
038         */
039        Map<String, ConfigurationMetadataGroup> getAllGroups();
040
041        /**
042         * Return the properties, indexed by id.
043         * @return all configuration meta-data properties
044         */
045        Map<String, ConfigurationMetadataProperty> getAllProperties();
046
047}