com.atlassian.greenhopper.customfield
Class CustomFieldMetadata

java.lang.Object
  com.atlassian.greenhopper.customfield.CustomFieldMetadata

public class CustomFieldMetadata
extends java.lang.Object

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

Author:

ahennecke

Nested Class Summary

static class

CustomFieldMetadata.Builder

Constructor Summary

CustomFieldMetadata(java.lang.String fieldName, java.lang.String fieldDescription, java.lang.String fieldType, java.lang.String fieldSearcher, IssueTypePrototype... issueTypePrototypes)
Deprecated.

CustomFieldMetadata(java.lang.String fieldName, java.lang.String fieldDescription, java.lang.String fieldType, java.lang.String fieldSearcher, java.util.Set<IssueTypePrototype> issueTypePrototypes)
Deprecated.

Method Summary

static CustomFieldMetadata.Builder	builder()
static CustomFieldMetadata.Builder	builder(CustomFieldMetadata source)
java.lang.String	getDefaultOptionName()
java.lang.String	getFieldDescription() the custom field description used by JIRA
java.lang.String	getFieldName() the custom field name used by JIRA
java.lang.String	getFieldSearcher() the key of the custom field searcher declaration in atlassian-plugins.xml
java.lang.String	getFieldType() the key of the custom field declaration in atlassian-plugins.xml
java.util.Set<IssueTypePrototype>	getIssueTypePrototypes() the IssueType keys this customField is assigned to.
java.util.List<java.lang.String>	getOptionNames()
boolean	isLockField()
boolean	isRequireField() Used to determine both "requiredness" and whether to add to the issue creation screen.
java.lang.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(java.lang.String fieldName,
                                      java.lang.String fieldDescription,
                                      java.lang.String fieldType,
                                      java.lang.String fieldSearcher,
                                      IssueTypePrototype... issueTypePrototypes)

Deprecated.

CustomFieldMetadata

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

Deprecated.

Method Detail

builder

public static CustomFieldMetadata.Builder builder()

builder

public static CustomFieldMetadata.Builder builder(CustomFieldMetadata source)

getFieldName

public java.lang.String getFieldName()

the custom field name used by JIRA

getFieldDescription

public java.lang.String getFieldDescription()

the custom field description used by JIRA

getFieldType

public java.lang.String getFieldType()

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

getFieldSearcher

public java.lang.String getFieldSearcher()

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

getIssueTypePrototypes

public java.util.Set<IssueTypePrototype> getIssueTypePrototypes()

the IssueType keys this customField is assigned to.

getOptionNames

public java.util.List<java.lang.String> getOptionNames()

getDefaultOptionName

public java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object