1 /*
2 * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package de.smartics.properties.spi.config.definition;
17
18 import de.smartics.properties.api.config.domain.key.ConfigurationKey;
19
20 /**
21 * Parses the given path to create a configuration key.
22 */
23 public interface DefinitionKeyHelper
24 {
25
26 /**
27 * Parses the given path to create a configuration key.
28 *
29 * @param pathWithFile the path to parse.
30 * @return the configuration key.
31 * @throws IllegalArgumentException if the given {@code path} is not valid
32 * according to the rules given above.
33 */
34 ConfigurationKey<?> parse(String pathWithFile)
35 throws IllegalArgumentException;
36
37 }