org.craftercms.commons.plugin.model

Class Parameter

java.lang.Object

org.craftercms.commons.plugin.model.Parameter

public class Parameter
extends Object

Holds the information for a parameter

Since:

3.1.4

Author:

joseross

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parameter.Type Possible types for the parameters

Field Summary

Fields

Modifier and Type	Field and Description
protected String	defaultValue The default value of the parameter
protected String	description The description of the parameter
protected String	label The label to display for the parameter
protected String	name The name of the parameter (must be camelCase)
static String	NAME_REGEX
protected boolean	required Indicates if the parameter is required
protected Parameter.Type	type The type of the parameter

Constructor Summary

Constructors

Constructor and Description
Parameter()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDefaultValue()
String	getDescription()
String	getLabel()
String	getName()
Parameter.Type	getType()
int	hashCode()
boolean	isRequired()
void	setDefaultValue(String defaultValue)
void	setDescription(String description)
void	setLabel(String label)
void	setName(String name)
void	setRequired(boolean required)
void	setType(Parameter.Type type)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAME_REGEX

public static String NAME_REGEX

label

protected String label

The label to display for the parameter

name

protected String name

The name of the parameter (must be camelCase)

description

protected String description

The description of the parameter

defaultValue

protected String defaultValue

The default value of the parameter

type

protected Parameter.Type type

The type of the parameter

required

protected boolean required

Indicates if the parameter is required

Constructor Detail

Parameter

public Parameter()

Method Detail

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getDefaultValue

public String getDefaultValue()

setDefaultValue

public void setDefaultValue(String defaultValue)

getType

public Parameter.Type getType()

setType

public void setType(Parameter.Type type)

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object