Package: StringViewModelMigrator

StringViewModelMigrator

Coverage

1: /*******************************************************************************
2: * Copyright (c) 2011-2015 EclipseSource Muenchen GmbH and others.
3: *
4: * All rights reserved. This program and the accompanying materials
5: * are made available under the terms of the Eclipse Public License 2.0
6: * which accompanies this distribution, and is available at
7: * https://www.eclipse.org/legal/epl-2.0/
8: *
9: * SPDX-License-Identifier: EPL-2.0
10: *
11: * Contributors:
12: * Johannes Faltermeier - initial API and implementation
13: ******************************************************************************/
14: package org.eclipse.emf.ecp.spi.view.migrator.string;
15:
16: import org.eclipse.emf.ecp.view.migrator.ViewModelMigrationException;
17:
18: /**
19: * A String View Model Migrator may migrate view models which are available in memory as a string representation.
20: *
21: * @author Johannes Faltermeier
22: * @since 1.8
23: *
24: */
25: public interface StringViewModelMigrator {
26:
27:         /**
28:          * Checks whether a view model needs to be migrated.
29:          *
30:          * @param serializedViewModel the view model that should be checked
31:          * @return true, if the view model does not require a migration, false otherwise.
32:          */
33:         boolean checkMigration(String serializedViewModel);
34:
35:         /**
36:          * Migrates a view model to the latest version.
37:          *
38:          * @param serializedViewModel the view model that should be checked
39:          * @return the migrated string
40:          * @throws ViewModelMigrationException in case of an error
41:          */
42:         String performMigration(String serializedViewModel) throws ViewModelMigrationException;
43: }