com.almworks.jira.structure.api.util

Class StructureUtil

java.lang.Object

com.almworks.jira.structure.api.util.StructureUtil

public class StructureUtil
extends Object

Contains miscellaneous utility methods.

Field Summary

Fields

Modifier and Type	Field and Description
static La<com.almworks.integers.IntIterator,Integer>	INT_ITERATOR_TO_INT
static org.codehaus.jackson.type.TypeReference<Map<String,Object>>	JSON_MAP
static La<com.almworks.integers.LongIterator,Long>	LONG_ITERATOR_TO_LONG
static int	MAX_PROPERTY_LENGTH
static La<String,Long>	STRING_LONG

Constructor Summary

Constructors

Constructor and Description
StructureUtil()

Method Summary

Modifier and Type	Method and Description
static StringBuilder	appendDebugIssueString(Long issue, StringBuilder sb)
static StringBuilder	appendDebugIssueString(Long issueId, String issueKey, StringBuilder r)
static StringBuilder	appendDebugStructureString(long structureId, StructureManager manager, StringBuilder sb)
static PermissionLevel	applyPermissions(List<PermissionRule> permissions, com.atlassian.jira.user.ApplicationUser user, List<Object> stack, La<Long,List<PermissionRule>> resolver, PermissionLevel pass)
static List<PermissionRule>	copyPermissions(Collection<? extends PermissionRule> permissions)
static List<PermissionRule>	copyPermissionsOrNull(Collection<? extends PermissionRule> permissions)
static JAXBContext	createJAXBContext(Class contextClass)
static int	createRuntimeSignature()
static String	debugAction(com.opensymphony.workflow.loader.ActionDescriptor action)
static String	debugConstant(com.atlassian.jira.issue.IssueConstant constant)
static String	decodeURL(String url)
static org.codehaus.jackson.map.ObjectMapper	defaultMapper()
static String	encodeURIComponent(String cmp)
static String	encodeURL(String url)
static Map<String,Object>	fromJson(String json)
static <T> T	fromJson(String specJson, Class<T> expectedClass)
static <T> T	fromJson(String specJson, Class<T> expectedClass, org.codehaus.jackson.map.ObjectMapper mapper)
static Map<String,Object>	fromJson(String json, org.codehaus.jackson.map.ObjectMapper mapper)
static <T> T	fromJson(String json, org.codehaus.jackson.type.TypeReference<T> typeRef)
static <T> T	fromJson(String json, org.codehaus.jackson.type.TypeReference<T> typeRef, org.codehaus.jackson.map.ObjectMapper mapper)
static <T> T	fromMap(Map json, Class<T> expectedClass)
static <T> T	fromMap(Map json, Class<T> expectedClass, org.codehaus.jackson.map.ObjectMapper mapper)
static com.atlassian.jira.user.ApplicationUser	getApplicationUserByName(String userName)
static String	getBaseUrl()
static boolean	getBooleanSystemProperty(String key, boolean defaultValue) Similar to Boolean.getBoolean(String), but with ability to specify default value if no value is specified.
static String	getDebugIssueKey(long issueId) Returns issue key if possible.
static String	getDebugIssueString(com.atlassian.jira.issue.Issue issue) Returns a string representation of the issue that is used to write log messages.
static String	getDebugIssueString(Long issue) Returns a string representation of the issue that is used to write log messages.
static String	getDebugRowString(long row)
static String	getDebugRowString(StructureRow row)
static String	getDebugStructureString(long structureId, StructureManager structureManager)
static String	getGroupName(com.atlassian.crowd.embedded.api.Group group)
static String	getItemDescription(ItemIdentity itemId)
static ItemDisplayable	getItemDisplayable(ItemForest fragment, StructureAttributeService attributeService)
static ItemDisplayable	getItemDisplayable(ItemIdentity itemId, StructureAttributeService attributeService)
static ItemDisplayable	getItemDisplayable(StructureRow row, StructureAttributeService attributeService)
static Locale	getJiraDefaultLocale()
static String	getLongProperty(com.atlassian.jira.config.properties.ApplicationProperties properties, String name) Reads a value previously stored in properties using setLongValue
static String	getMessageWithCauseChain(Throwable t)
static List<String>	getMultiParameter(Map map, String name)
static List<Long>	getMultiParameterLong(Map map, String name)
static String	getSingleParameter(Map map, String name)
static boolean	getSingleParameterBoolean(Map map, String name)
static Integer	getSingleParameterInteger(Map map, String name)
static Long	getSingleParameterLong(Map map, String name)
static String	getText(Locale locale, com.atlassian.jira.user.ApplicationUser user, String textKey, Object... messageParameters) Formats the text taken from the i18n bundle with the specified parameters in the locale that is selected as follows: If locale is not null, it is used. Otherwise, if user is not null, the user locale (set up in the user preferences) is used. If both locale and user are null, JIRA default locale is used.
static String	getTextInCurrentUserLocale(String key, Object... parameters)
static com.atlassian.jira.user.ApplicationUser	getUserByKey(String userKey)
static String	getUserKey(com.atlassian.jira.user.ApplicationUser user)
static String	getUserName(com.atlassian.jira.user.ApplicationUser user)
static String	getUserNameByKey(String userKey)
static boolean	isDevMode()
static boolean	isMutuallyExclusive(com.almworks.integers.LongList set1, com.almworks.integers.LongList set2)
static boolean	isMutuallyExclusive(com.almworks.integers.LongSet set1, com.almworks.integers.LongSet set2)
static boolean	isSubMap(Map<String,Object> map, Map<String,Object> subMap)
static String	issueKeyOrId(com.atlassian.jira.issue.Issue issue, Long issueId)
static int	iv(String v, int defaultValue)
static long	lastOrZero(com.almworks.integers.LongList list) Returns the last element of the given list if it's not empty, 0 otherwise.
static boolean	listsEqual(com.almworks.integers.LongList list1, com.almworks.integers.LongList list2) Tests whether the given lists are equal (contain the same numbers in the same order).
static <T> Class<List<T>>	listType()
static long	lv(String v, long defaultValue)
static Long	lvn(String v)
static <T,V> Class<Map<T,V>>	mapType()
static String	migrateUserNameToUserKey(String userName)
static int	nn(Integer value, int defaultValue)
static long	nn(Long value, long defaultValue)
static String	nn(String value)
static int	nni(Integer value)
static long	nnl(Long value)
static <T> T	nnv(T value, T defaultValue)
static String	nonBlank(String value)
static boolean	onlyOneIsTrue(boolean... booleans)
static void	setLongProperty(com.atlassian.jira.config.properties.ApplicationProperties properties, String name, String value) Sets a possibly long value (template) as an application property.
static <T> Class<Set<T>>	setType()
static <T> void	swap(List<T> list, int a, int b)
static String	toDebugJson(Object object)
static String	toJson(Object object)
static String	toJson(Object object, org.codehaus.jackson.map.ObjectMapper mapper)
static Map<String,Object>	toMap(Object object)
static Map<String,Object>	toMap(Object object, org.codehaus.jackson.map.ObjectMapper mapper)
static String	username(com.atlassian.jira.user.ApplicationUser user)
static void	warnExceptionIfDebug(org.slf4j.Logger log, String message, Throwable t)
static org.codehaus.jackson.map.ObjectMapper	withUnknownPropertiesMapper()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_PROPERTY_LENGTH

public static final int MAX_PROPERTY_LENGTH

See Also:

Constant Field Values

STRING_LONG

public static final La<String,Long> STRING_LONG

INT_ITERATOR_TO_INT

public static final La<com.almworks.integers.IntIterator,Integer> INT_ITERATOR_TO_INT

LONG_ITERATOR_TO_LONG

public static final La<com.almworks.integers.LongIterator,Long> LONG_ITERATOR_TO_LONG

JSON_MAP

public static final org.codehaus.jackson.type.TypeReference<Map<String,Object>> JSON_MAP

Constructor Detail

StructureUtil

public StructureUtil()

Method Detail

applyPermissions

public static PermissionLevel applyPermissions(List<PermissionRule> permissions,
                                               com.atlassian.jira.user.ApplicationUser user,
                                               List<Object> stack,
                                               La<Long,List<PermissionRule>> resolver,
                                               PermissionLevel pass)

createJAXBContext

public static JAXBContext createJAXBContext(Class contextClass)

getSingleParameterLong

@Nullable
public static Long getSingleParameterLong(@Nullable
                                                    Map map,
                                                    @Nullable
                                                    String name)

getSingleParameterInteger

@Nullable
public static Integer getSingleParameterInteger(@Nullable
                                                          Map map,
                                                          @Nullable
                                                          String name)

getSingleParameterBoolean

public static boolean getSingleParameterBoolean(@Nullable
                                                Map map,
                                                @Nullable
                                                String name)

getSingleParameter

@Nullable
public static String getSingleParameter(@Nullable
                                                  Map map,
                                                  @Nullable
                                                  String name)

getMultiParameter

@NotNull
public static List<String> getMultiParameter(@Nullable
                                                      Map map,
                                                      @Nullable
                                                      String name)

getMultiParameterLong

@NotNull
public static List<Long> getMultiParameterLong(@Nullable
                                                        Map map,
                                                        @Nullable
                                                        String name)

setLongProperty

public static void setLongProperty(com.atlassian.jira.config.properties.ApplicationProperties properties,
                                   String name,
                                   String value)

Sets a possibly long value (template) as an application property. Because properties may be limited to 255 characters, this method breaks up long property into several properties each no longer than allowed.

Parameters:

properties - properties interface

name - the name of the property

value - the value

getLongProperty

@NotNull
public static String getLongProperty(com.atlassian.jira.config.properties.ApplicationProperties properties,
                                              String name)

Reads a value previously stored in properties using setLongValue

Parameters:

properties - application propeties

name - the name of the property to read

Returns:

property value or an empty string

getBooleanSystemProperty

public static boolean getBooleanSystemProperty(String key,
                                               boolean defaultValue)

Similar to Boolean.getBoolean(String), but with ability to specify default value if no value is specified.

lastOrZero

public static long lastOrZero(com.almworks.integers.LongList list)

Returns the last element of the given list if it's not empty, 0 otherwise.

Parameters:

list - the list of longs

Returns:

last value of list or 0 if it's empty.

listsEqual

public static boolean listsEqual(com.almworks.integers.LongList list1,
                                 com.almworks.integers.LongList list2)

Tests whether the given lists are equal (contain the same numbers in the same order). An empty list is considered equal to a null list.

Parameters:

list1 - the first list

list2 - the second list

Returns:

true if the lists are equal, false otherwise.

copyPermissionsOrNull

@Nullable
public static List<PermissionRule> copyPermissionsOrNull(@Nullable
                                                                   Collection<? extends PermissionRule> permissions)

copyPermissions

@NotNull
public static List<PermissionRule> copyPermissions(@Nullable
                                                            Collection<? extends PermissionRule> permissions)

getDebugIssueString

@NotNull
public static String getDebugIssueString(@Nullable
                                                  Long issue)

Returns a string representation of the issue that is used to write log messages. Writes issue ID and, if possible, issue key.

Parameters:

issue - the ID of the issue

Returns:

string that can be used in output

appendDebugIssueString

public static StringBuilder appendDebugIssueString(@Nullable
                                                   Long issue,
                                                   StringBuilder sb)

getDebugIssueKey

@Nullable
public static String getDebugIssueKey(long issueId)

Returns issue key if possible. Use for debug output.

getDebugIssueString

@NotNull
public static String getDebugIssueString(@Nullable
                                                  com.atlassian.jira.issue.Issue issue)

Returns a string representation of the issue that is used to write log messages. Writes issue ID and, if possible, issue key.

Parameters:

issue - the issue

Returns:

string that can be used in output

issueKeyOrId

public static String issueKeyOrId(@Nullable
                                  com.atlassian.jira.issue.Issue issue,
                                  @Nullable
                                  Long issueId)

Returns:

issue key if the issue object is not null. Otherwise, if issue ID is not null, returns issue ID in the form "issue #123". Otherwise, returns string "(no issue ID)". Better suited for high-level log messages than getDebugIssueString(java.lang.Long) in that it is easily recognizable as issue representation to JIRA admin.

appendDebugIssueString

@NotNull
public static StringBuilder appendDebugIssueString(@Nullable
                                                            Long issueId,
                                                            @Nullable
                                                            String issueKey,
                                                            StringBuilder r)

appendDebugStructureString

@NotNull
public static StringBuilder appendDebugStructureString(long structureId,
                                                                StructureManager manager,
                                                                StringBuilder sb)

getDebugStructureString

public static String getDebugStructureString(long structureId,
                                             StructureManager structureManager)

username

@NotNull
public static String username(@Nullable
                                       com.atlassian.jira.user.ApplicationUser user)

debugConstant

public static String debugConstant(com.atlassian.jira.issue.IssueConstant constant)

debugAction

public static String debugAction(com.opensymphony.workflow.loader.ActionDescriptor action)

getTextInCurrentUserLocale

public static String getTextInCurrentUserLocale(String key,
                                                Object... parameters)

getText

@NotNull
public static String getText(@Nullable
                                      Locale locale,
                                      @Nullable
                                      com.atlassian.jira.user.ApplicationUser user,
                                      String textKey,
                                      Object... messageParameters)

Formats the text taken from the i18n bundle with the specified parameters in the locale that is selected as follows:

1. If locale is not null, it is used.
2. Otherwise, if user is not null, the user locale (set up in the user preferences) is used.
3. If both locale and user are null, JIRA default locale is used. In a highly unlikely event when JIRA application parameters are inaccessible, root (neutral) locale is used.

Parameters:

messageParameters - can be the same as I18nHelper.getText(String, Object)

getJiraDefaultLocale

@NotNull
public static Locale getJiraDefaultLocale()

getUserKey

public static String getUserKey(@Nullable
                                com.atlassian.jira.user.ApplicationUser user)

getUserName

@Nullable
public static String getUserName(@Nullable
                                           com.atlassian.jira.user.ApplicationUser user)

getUserByKey

@Nullable
public static com.atlassian.jira.user.ApplicationUser getUserByKey(@Nullable
                                                                             String userKey)

getApplicationUserByName

@Nullable
public static com.atlassian.jira.user.ApplicationUser getApplicationUserByName(@Nullable
                                                                                         String userName)

getUserNameByKey

@Nullable
public static String getUserNameByKey(@Nullable
                                                String userKey)

migrateUserNameToUserKey

@Nullable
public static String migrateUserNameToUserKey(@Nullable
                                                        String userName)

createRuntimeSignature

public static int createRuntimeSignature()

Returns:

a fairly random number that is used to identify the scope of some other data for external components with longer lifecycle (such as browsers or other addons). The signature is retrieved once per component lifecycle and all other data it provides is valid only within the same signature.

getDebugRowString

public static String getDebugRowString(long row)

getDebugRowString

public static String getDebugRowString(StructureRow row)

toJson

@NotNull
public static String toJson(@Nullable
                                     Object object)

toJson

@NotNull
public static String toJson(@Nullable
                                     Object object,
                                     org.codehaus.jackson.map.ObjectMapper mapper)

fromJson

@Nullable
public static <T> T fromJson(String specJson,
                                       Class<T> expectedClass)

fromJson

@Nullable
public static <T> T fromJson(String specJson,
                                       Class<T> expectedClass,
                                       org.codehaus.jackson.map.ObjectMapper mapper)

fromJson

@Nullable
public static <T> T fromJson(String json,
                                       org.codehaus.jackson.type.TypeReference<T> typeRef)

fromJson

@Nullable
public static <T> T fromJson(String json,
                                       org.codehaus.jackson.type.TypeReference<T> typeRef,
                                       org.codehaus.jackson.map.ObjectMapper mapper)

fromJson

public static Map<String,Object> fromJson(String json)

fromJson

@Nullable
public static Map<String,Object> fromJson(String json,
                                                    org.codehaus.jackson.map.ObjectMapper mapper)

fromMap

@Nullable
public static <T> T fromMap(Map json,
                                      Class<T> expectedClass)

fromMap

@Nullable
public static <T> T fromMap(Map json,
                                      Class<T> expectedClass,
                                      org.codehaus.jackson.map.ObjectMapper mapper)

toMap

@Nullable
public static Map<String,Object> toMap(Object object)

toMap

@Nullable
public static Map<String,Object> toMap(Object object,
                                                 org.codehaus.jackson.map.ObjectMapper mapper)

defaultMapper

public static org.codehaus.jackson.map.ObjectMapper defaultMapper()

withUnknownPropertiesMapper

public static org.codehaus.jackson.map.ObjectMapper withUnknownPropertiesMapper()

setType

public static <T> Class<Set<T>> setType()

mapType

public static <T,V> Class<Map<T,V>> mapType()

listType

public static <T> Class<List<T>> listType()

onlyOneIsTrue

public static boolean onlyOneIsTrue(boolean... booleans)

swap

public static <T> void swap(List<T> list,
                            int a,
                            int b)

warnExceptionIfDebug

public static void warnExceptionIfDebug(org.slf4j.Logger log,
                                        String message,
                                        Throwable t)

getMessageWithCauseChain

public static String getMessageWithCauseChain(Throwable t)

getItemDescription

public static String getItemDescription(ItemIdentity itemId)

getItemDisplayable

public static ItemDisplayable getItemDisplayable(ItemIdentity itemId,
                                                 StructureAttributeService attributeService)

getItemDisplayable

public static ItemDisplayable getItemDisplayable(StructureRow row,
                                                 StructureAttributeService attributeService)

getItemDisplayable

public static ItemDisplayable getItemDisplayable(ItemForest fragment,
                                                 StructureAttributeService attributeService)

getGroupName

@Nullable
public static String getGroupName(com.atlassian.crowd.embedded.api.Group group)

isMutuallyExclusive

public static boolean isMutuallyExclusive(com.almworks.integers.LongList set1,
                                          com.almworks.integers.LongList set2)

isMutuallyExclusive

public static boolean isMutuallyExclusive(com.almworks.integers.LongSet set1,
                                          com.almworks.integers.LongSet set2)

toDebugJson

@NotNull
public static String toDebugJson(@Nullable
                                          Object object)

nn

public static long nn(@Nullable
                      Long value,
                      long defaultValue)

nn

public static int nn(@Nullable
                     Integer value,
                     int defaultValue)

nnv

@NotNull
public static <T> T nnv(@Nullable
                                 T value,
                                 @NotNull
                                 T defaultValue)

lv

public static long lv(String v,
                      long defaultValue)

iv

public static int iv(String v,
                     int defaultValue)

lvn

public static Long lvn(String v)

nn

public static String nn(String value)

nnl

public static long nnl(Long value)

nni

public static int nni(Integer value)

getBaseUrl

@NotNull
public static String getBaseUrl()

decodeURL

public static String decodeURL(String url)

encodeURL

public static String encodeURL(String url)

encodeURIComponent

public static String encodeURIComponent(String cmp)

isSubMap

public static boolean isSubMap(Map<String,Object> map,
                               Map<String,Object> subMap)

isDevMode

@Internal
public static boolean isDevMode()

nonBlank

@NotNull
public static String nonBlank(@Nullable
                                       String value)
                                throws IllegalArgumentException

Throws:

IllegalArgumentException