com.atlassian.jira.bc.admin
Class ApplicationPropertyMetadata

java.lang.Object
  extended by 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

Nested Class Summary
static class ApplicationPropertyMetadata.Builder
           
 
Method Summary
 String getDefaultValue()
           
 String getDescription()
           
 String getDescriptionKey()
           
 ApplicationPropertyEnumerator getEnumerator()
           
 ExampleGenerator getExampleGenerator()
           
 String getKey()
           
 String getName()
           
 String getNameKey()
           
 Pair<String,Boolean> getRequiredFeatureKey()
           
 String getType()
           
 Validator getValidator()
           
 boolean isAdminEditable()
           
 boolean isRequiresRestart()
          Whether or not changing the property value requires a restart in order to take effect.
 boolean isSysadminEditable()
           
 Validator.Result validate(String value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getType

public String getType()

getKey

public String getKey()

isSysadminEditable

public boolean isSysadminEditable()

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()

getNameKey

public String getNameKey()

getDescription

public String getDescription()

getDescriptionKey

public String getDescriptionKey()

getDefaultValue

public String getDefaultValue()

getValidator

public Validator getValidator()

getEnumerator

public ApplicationPropertyEnumerator getEnumerator()

validate

public Validator.Result validate(String value)

isAdminEditable

public boolean isAdminEditable()

getExampleGenerator

public ExampleGenerator getExampleGenerator()

getRequiredFeatureKey

public Pair<String,Boolean> getRequiredFeatureKey()


Copyright © 2002-2012 Atlassian. All Rights Reserved.