com.atlassian.jira.bc.admin
Class ApplicationPropertyMetadata

java.lang.Object
  com.atlassian.jira.bc.admin.ApplicationPropertyMetadata

public class ApplicationPropertyMetadata
extends Object

Represents an individual property setting as defined in the jpm.xml file. This implementation models the various metadata about a single JIRA application property and also provides access to some type and validation logic.

Since:

v4.4

Constructor Summary

ApplicationPropertyMetadata(String key, String type, String defaultValue, String validatorName, boolean userEditable, boolean requiresRestart, String name, String desc, ApplicationPropertyEnumerator enumerator)

ApplicationPropertyMetadata(String key, String type, String defaultValue, com.google.common.base.Supplier<? extends Validator> validatorSupplier, boolean userEditable, boolean requiresRestart)

ApplicationPropertyMetadata(String key, String type, String defaultValue, com.google.common.base.Supplier<? extends Validator> validatorSupplier, boolean userEditable, boolean requiresRestart, String name, String desc, ApplicationPropertyEnumerator enumerator)

Method Summary

String	getDefaultValue()
String	getDescription()
ApplicationPropertyEnumerator	getEnumerator()
String	getKey()
String	getName()
String	getType()
Validator	getValidator()
boolean	isRequiresRestart() Whether or not changing the property value requires a restart in order to take effect.
boolean	isUserEditable()
Validator.Result	validate(String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationPropertyMetadata

public ApplicationPropertyMetadata(String key,
                                   String type,
                                   String defaultValue,
                                   com.google.common.base.Supplier<? extends Validator> validatorSupplier,
                                   boolean userEditable,
                                   boolean requiresRestart)

ApplicationPropertyMetadata

public ApplicationPropertyMetadata(String key,
                                   String type,
                                   String defaultValue,
                                   String validatorName,
                                   boolean userEditable,
                                   boolean requiresRestart,
                                   String name,
                                   String desc,
                                   ApplicationPropertyEnumerator enumerator)

ApplicationPropertyMetadata

public ApplicationPropertyMetadata(String key,
                                   String type,
                                   String defaultValue,
                                   com.google.common.base.Supplier<? extends Validator> validatorSupplier,
                                   boolean userEditable,
                                   boolean requiresRestart,
                                   String name,
                                   String desc,
                                   ApplicationPropertyEnumerator enumerator)

Method Detail

getType

public String getType()

getKey

public String getKey()

isUserEditable

public boolean isUserEditable()

isRequiresRestart

public boolean isRequiresRestart()

Whether or not changing the property value requires a restart in order to take effect.

Returns:

true only if the property requires a restart.

getName

public String getName()

getDescription

public String getDescription()

getDefaultValue

public String getDefaultValue()

getValidator

public Validator getValidator()

getEnumerator

public ApplicationPropertyEnumerator getEnumerator()

validate

public Validator.Result validate(String value)