-
Notifications
You must be signed in to change notification settings - Fork 44
/
DefaultKey.scala
46 lines (41 loc) · 1.49 KB
/
DefaultKey.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/*
* Copyright 2012-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package laika.api.config
/** A defaultKey can be used for commonly used configuration objects like `AutonumberConfig`
* that are expected to be mapped to a specific key, like `autonumbering` without requiring
* the user to remember these keys.
*
* {{{
* val config: Config = ???
* val res: ConfigResult[AutonumberConfig] = config.get[AutonumberConfig]
* }}}
*
* In the example above retrieval happens solely based on the type of the result
* with the associated key being specified by an implicit `DefaultKey`.
*
* @author Jens Halm
*/
trait DefaultKey[T] {
def value: Key
}
object DefaultKey {
/** Creates a new instance for the specified key.
*/
def apply[T](key: Key): DefaultKey[T] = new DefaultKey[T] { val value: Key = key }
/** Creates a new instance for the specified key.
*/
def apply[T](key: String): DefaultKey[T] = apply(Key.parse(key))
}