blob: 23782162725b6567fc0661c4d6fa18b8cfcab033 (
plain) (
blame)
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
|
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.config.model.api;
import com.yahoo.component.Version;
/**
* Factory for config models.
*/
public interface ModelFactory {
/**
* Returns the Vespa version of the models this builds.
*
* @return the version of a {@link Model} instance that this factory can create.
*/
@SuppressWarnings("deprecation")
default Version version() { // TODO: Remove this default implementationm after December 2018
return getVersion().toVersion();
}
/** @deprecated use and override version(). TODO: Remove this method after December 2018 */
@Deprecated
default com.yahoo.config.provision.Version getVersion() { return com.yahoo.config.provision.Version.from(version()); }
/**
* Creates an instance of a {@link Model}. The resulting instance will be used to serve config. No model
* validation will be done, calling this method assumes that{@link #createAndValidateModel(ModelContext, ValidationParameters)}
* has already been called at some point for this model.
*
* @param modelContext an instance of {@link ModelContext}, containing dependencies for creating a {@link Model}.
* @return a {@link Model} instance.
*/
Model createModel(ModelContext modelContext);
/**
* Creates an instance of a {@link Model}. The resulting instance will be used to serve config. Any validation
* of a {@link Model} and the {@link ModelContext} can be done in this method.
*
* @param modelContext an instance of {@link ModelContext}, containing dependencies for creating a {@link Model}
* @param validationParameters validation parameters
* @return a {@link ModelCreateResult} instance.
*/
ModelCreateResult createAndValidateModel(ModelContext modelContext, ValidationParameters validationParameters);
}
|