Package 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

  • Field Details

    • 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 Details

    • Parameter

      public Parameter()

  • Method Details

    • 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