com.atlassian.greenhopper.customfield

Class CustomFieldMetadata

java.lang.Object

com.atlassian.greenhopper.customfield.CustomFieldMetadata

public class CustomFieldMetadata
extends Object

Describes the configuration keys necessary for managing a custom field in JIRA

Author:

ahennecke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomFieldMetadata.Builder

Constructor Summary

Constructors

Constructor and Description
CustomFieldMetadata(String fieldName, String fieldDescription, String fieldType, String fieldSearcher, IssueTypePrototype... issueTypePrototypes) Deprecated.
CustomFieldMetadata(String fieldName, String fieldDescription, String fieldType, String fieldSearcher, Set<IssueTypePrototype> issueTypePrototypes) Deprecated.

Method Summary

Modifier and Type	Method and Description
static CustomFieldMetadata.Builder	builder()
static CustomFieldMetadata.Builder	builder(CustomFieldMetadata source)
String	getDefaultOptionName()
String	getFieldDescription() the custom field description used by JIRA
String	getFieldName() the custom field name used by JIRA
String	getFieldSearcher() the key of the custom field searcher declaration in atlassian-plugins.xml
String	getFieldType() the key of the custom field declaration in atlassian-plugins.xml
Set<IssueTypePrototype>	getIssueTypePrototypes() the IssueType keys this customField is assigned to.
List<String>	getOptionNames()
boolean	isLockField()
boolean	isRequireField() Used to determine both "requiredness" and whether to add to the issue creation screen.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFieldMetadata

@Deprecated
public CustomFieldMetadata(String fieldName,
                                       String fieldDescription,
                                       String fieldType,
                                       String fieldSearcher,
                                       IssueTypePrototype... issueTypePrototypes)

Deprecated.

CustomFieldMetadata

@Deprecated
public CustomFieldMetadata(String fieldName,
                                       String fieldDescription,
                                       String fieldType,
                                       String fieldSearcher,
                                       Set<IssueTypePrototype> issueTypePrototypes)

Deprecated.

Method Detail

builder

public static CustomFieldMetadata.Builder builder()

builder

public static CustomFieldMetadata.Builder builder(CustomFieldMetadata source)

getFieldName

public String getFieldName()

the custom field name used by JIRA

getFieldDescription

public String getFieldDescription()

the custom field description used by JIRA

getFieldType

public String getFieldType()

the key of the custom field declaration in atlassian-plugins.xml

getFieldSearcher

public String getFieldSearcher()

the key of the custom field searcher declaration in atlassian-plugins.xml

getIssueTypePrototypes

public Set<IssueTypePrototype> getIssueTypePrototypes()

the IssueType keys this customField is assigned to.

getOptionNames

public List<String> getOptionNames()

getDefaultOptionName

public String getDefaultOptionName()

isLockField

public boolean isLockField()

isRequireField

public boolean isRequireField()

Used to determine both "requiredness" and whether to add to the issue creation screen.

Returns:

toString

public String toString()

Overrides:

toString in class Object