Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 2d944c254d0892fa82bb5058609f0939567eb5db (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/*****************************************************************************
 * Copyright (c) 2013 CEA LIST.
 *
 *
 * 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:
 *  Vincent Lorenzo (CEA LIST) vincent.lorenzo@cea.fr - Initial API and implementation
 *
 *****************************************************************************/
package org.eclipse.papyrus.infra.ui.converter;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.osgi.util.NLS;
import org.eclipse.papyrus.infra.ui.Activator;
import org.eclipse.papyrus.infra.ui.messages.Messages;

/**
 * Abstract class for String value Container
 *
 * @author VL222926
 * @since 1.2
 *
 */
public abstract class AbstractStringValueConverter implements IStringValueConverter {

	protected static final String THE_STRING_X_IS_NOT_VALID_TO_CREATE_Y = Messages.AbstractStringValueConverter_TheStringXIsNotValidToCreateY;

	protected static final String THE_FEATURE_X_CANT_BE_RESOLVED = Messages.AbstractStringValueConverter_TheFeatureXCantBeResolved;

	protected static final String THE_STRING_VALUE_X_CANT_BE_RESOLVED = Messages.AbstractStringValueConverter_TheStringValueXCantBeResolved;

	protected static final String SOME_STRING_ARE_NOT_VALID_TO_CREATE_X = Messages.AbstractStringValueConverter_SomeStringsAreNotValidToCreateY;

	protected static final String SOME_STRING_CANT_BE_RESOLVED_TO_FIND_X = Messages.AbstractStringValueConverter_SomeStringsCantBeResolvedToFindY;

	protected static final String NO_X_REPRESENTED_BY_Y_HAVE_BEEN_FOUND = Messages.AbstractStringValueConverter_NoXReprensentedByYHaveBeenFound;

	private ConvertedValueContainer<?> result;

	/**
	 *
	 * @see org.eclipse.papyrus.infra.ui.converter.IStringValueConverter#deduceValueFromString(java.lang.Object, java.lang.String)
	 *
	 * @param type
	 * @param valueAsString
	 * @return
	 */
	@Override
	public final ConvertedValueContainer<?> deduceValueFromString(final Object type, final String valueAsString) {
		result = doDeduceValueFromString(type, valueAsString);
		if (result == null) {
			final IStatus status = new Status(IStatus.ERROR, Activator.PLUGIN_ID, NLS.bind(THE_STRING_VALUE_X_CANT_BE_RESOLVED, valueAsString));
			result = new ConvertedValueContainer<Object>(null, status);
		}
		return result;
	}

	/**
	 * 
	 * @return
	 * 		the converted value, you should call deduceValueFromString before to call this method
	 */
	public final ConvertedValueContainer<?> getConvertedValue() {
		if (this.result == null) {
			throw new IllegalStateException("You should call deduceValueFromString before to call this method"); //$NON-NLS-1$
		}
		return this.result;
	}

	/**
	 *
	 * @param type
	 *            the type of the object
	 * @param valueAsString
	 *            the string to resolve
	 * @return
	 * 		a {@link ConvertedValueContainer} with the resolved values and a status
	 */
	protected abstract ConvertedValueContainer<?> doDeduceValueFromString(final Object type, final String valueAsString);


}

Back to the top