diff options
author | David Green | 2013-07-23 23:54:38 +0000 |
---|---|---|
committer | David Green | 2013-10-23 21:48:59 +0000 |
commit | 9c7ab4a6357cdacf9491a74f0d47772e2be63778 (patch) | |
tree | c845e2df044496573d8238ee3d63e3fe72073dc8 /org.eclipse.mylyn.tasks.core/src/org/eclipse | |
parent | d0f959c177635edd9c5c4805c7b3d4ace3b400f7 (diff) | |
download | org.eclipse.mylyn.tasks-9c7ab4a6357cdacf9491a74f0d47772e2be63778.tar.gz org.eclipse.mylyn.tasks-9c7ab4a6357cdacf9491a74f0d47772e2be63778.tar.xz org.eclipse.mylyn.tasks-9c7ab4a6357cdacf9491a74f0d47772e2be63778.zip |
413584: provide API for encoding/decoding task id
added TaskIdEncoder with tests
Change-Id: I7e5628634c25df967770fc3f6515060713fc2e94
Task-Url: https://bugs.eclipse.org/bugs/show_bug.cgi?id=413584
Diffstat (limited to 'org.eclipse.mylyn.tasks.core/src/org/eclipse')
-rw-r--r-- | org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/spi/TaskIdEncoder.java | 51 | ||||
-rw-r--r-- | org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/spi/package-info.java | 16 |
2 files changed, 67 insertions, 0 deletions
diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/spi/TaskIdEncoder.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/spi/TaskIdEncoder.java new file mode 100644 index 000000000..14042a56f --- /dev/null +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/spi/TaskIdEncoder.java @@ -0,0 +1,51 @@ +/******************************************************************************* + * Copyright (c) 2013 Tasktop Technologies and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Tasktop Technologies - initial API and implementation + *******************************************************************************/ + +package org.eclipse.mylyn.tasks.core.spi; + +import static org.eclipse.core.runtime.Assert.isNotNull; + +/** + * An encoder that can encode/decode task ids. Task ids must not contain specific characters when used in the Mylyn + * framework. This class can be used to safely encode a task id to the Mylyn-acceptable form, and decode it back to the + * repository-specific form. + * + * @since 3.10 + */ +public class TaskIdEncoder { + /** + * Encodes the given {@code repositoryId} to a form that is acceptable to Mylyn. + * + * @param repositoryId + * the repository id to encode + * @return the encoded id + * @see #decode(String) + */ + public static String encode(String repositoryId) { + isNotNull(repositoryId); + return repositoryId.replaceAll("%", "%25").replaceAll( //$NON-NLS-1$ //$NON-NLS-2$ + org.eclipse.mylyn.internal.tasks.core.RepositoryTaskHandleUtil.HANDLE_DELIM, "%2D"); //$NON-NLS-1$ + } + + /** + * Decodes the given {@code encodedForm} to it's original format. + * + * @param encodedForm + * the decoded form of the string, previously obtained from {@link #encode(String)} + * @return the decoded string + */ + public static String decode(String encodedForm) { + isNotNull(encodedForm); + return encodedForm.replaceAll( + "%2D", org.eclipse.mylyn.internal.tasks.core.RepositoryTaskHandleUtil.HANDLE_DELIM) //$NON-NLS-1$ + .replaceAll("%25", "%"); //$NON-NLS-1$//$NON-NLS-2$ + } +} diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/spi/package-info.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/spi/package-info.java new file mode 100644 index 000000000..a216aa8c5 --- /dev/null +++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/tasks/core/spi/package-info.java @@ -0,0 +1,16 @@ +/******************************************************************************* + * Copyright (c) 2013 Tasktop Technologies and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Tasktop Technologies - initial API and implementation + *******************************************************************************/ + +/** + * Provides API for connector implementors. + */ +package org.eclipse.mylyn.tasks.core.spi; + |