T
- The type of parameter used by this model builder.ToolingModelBuilder
public interface ParameterizedToolingModelBuilder<T> extends ToolingModelBuilder
ToolingModelBuilder
which can be parameterized by the client.
The parameter type T
must be an interface and must follow a contract described in getParameterType()
.
The parameter type T
does not need to implement the interface defined in the client side, but it does need to have the same structure.
The Tooling API will create a view from the client side parameter type to the one defined in this model builder, and deal automatically with
missing methods in order to allow evolution of the models.
All classes implementing this interface should also implement methods from ToolingModelBuilder
, which will be used to determine if
a model can be built by the current builder and to generate the model in case no parameter is passed from the client.
The parameter type should be bound to the model type.
ToolingModelBuilder
Modifier and Type | Method | Description |
---|---|---|
java.lang.Object |
buildAll(java.lang.String modelName,
T parameter,
Project project) |
Creates the model of the given type for the given project using the given parameter.
|
java.lang.Class<T> |
getParameterType() |
Returns the expected type of the parameter.
|
buildAll, canBuild
java.lang.Class<T> getParameterType()
Contract
The parameter type must conform to the following rules:
For each getter-like method:
"get"
or "is"
, followed by an uppercase letter.void
.For each setter-like method:
"set"
, followed by an uppercase letter.void
.Example
Here is an example of a valid parameter type declaration:
public interface MyParameter {
String getValue();
void setValue(String value);
boolean isFlag();
void setFlag(boolean value);
}
java.lang.Object buildAll(java.lang.String modelName, T parameter, Project project)
modelName
- The model name, usually the same as the name of the Java interface used by the client.parameter
- The parameter received from the client.project
- The project to create the model for.