debug/org.eclipse.ptp.debug.core/src/org/eclipse/ptp/debug/core/model/IPPersistableRegisterGroup.java

/*******************************************************************************
 * Copyright (c) 2005 The Regents of the University of California. 
 * This material was produced under U.S. Government contract W-7405-ENG-36 
 * for Los Alamos National Laboratory, which is operated by the University 
 * of California for the U.S. Department of Energy. The U.S. Government has 
 * rights to use, reproduce, and distribute this software. NEITHER THE 
 * GOVERNMENT NOR THE UNIVERSITY MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR 
 * ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE. If software is modified 
 * to produce derivative works, such modified software should be clearly marked, 
 * so as not to confuse it with the version available from LANL.
 * 
 * Additionally, 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
 * 
 * LA-CC 04-115
 *******************************************************************************/
package org.eclipse.ptp.debug.core.model;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.model.IRegisterGroup;

/**
 * @author clement
 *
 */
public interface IPPersistableRegisterGroup extends IRegisterGroup {
	/**
	 * Returns a memento that can be used to reconstruct this group
	 * @return a memento that can be used to reconstruct this group
	 * @exception CoreException if unable to construct a memento
	 */
	public String getMemento() throws CoreException;
	
	/**
	 * Initializes this group based on the given memento.
	 * @param memento a memento to initialize this group
	 * @exception CoreException on failure to initialize 
	 */
	public void initializeFromMemento(String memento) throws CoreException;

	/**
	 * Returns the array of group's register descriptors.
	 * @return the array of group's register descriptors
	 */
	public IPRegisterDescriptor[] getRegisterDescriptors();

	/**
	 * Replaces the group register descriptors by the specified descriptors.
	 * @param the array of register descriptors
	 */
	public void setRegisterDescriptors(IPRegisterDescriptor[] registerDescriptors);
}