Package io.codemodder

Annotation Interface CodemodParameter

@Retention(RUNTIME)
@Qualifier
@Target(PARAMETER)
public @interface CodemodParameter

Describes a codemod parameter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CodemodParameter.ParameterType

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	defaultValue	The default value if the user didn't specify one.
String	label	A description of the parameter.
String	name	The name of the parameter.
String	question	The question to ask the user when they are prompted for this parameter.
String	validationPattern	A regex pattern that describes the valid values for this parameter.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
CodemodParameter.ParameterType	type	The type of the parameter.

Element Details

question

String question

The question to ask the user when they are prompted for this parameter.

name

String name

The name of the parameter.

label

String label

A description of the parameter.

defaultValue

String defaultValue

The default value if the user didn't specify one.

validationPattern

String validationPattern

A regex pattern that describes the valid values for this parameter.

type

CodemodParameter.ParameterType type

The type of the parameter. This is used to determine how to parse the value from the user.

Default:

STRING