blob: c19ca1045707395a7c98d17011869846d15462d9 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2006, 2012 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.launching;
import java.util.Map;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
/**
* Optional extensions that may be implemented by an
* {@link org.eclipse.jdt.launching.IVMInstall}, providing access to
* a JRE's system properties.
* <p>
* Clients that implement {@link org.eclipse.jdt.launching.IVMInstall} may additionally
* implement this interface. However, it is strongly recommended that clients subclass
* {@link org.eclipse.jdt.launching.AbstractVMInstall} instead, which already implements
* this interface, and will insulate clients from additional API additions in the future.
* </p>
* @since 3.2
*/
public interface IVMInstall3 {
/**
* Evaluates the specified system properties in this VM, returning the result
* as a map of property names to property values.
*
* @param properties the property names to evaluate, for example <code>{"user.home"}</code>
* @param monitor progress monitor or <code>null</code>
* @return map of system property names to associated property values
* @throws CoreException if an exception occurs evaluating the properties
* @since 3.2
*/
public Map<String, String> evaluateSystemProperties(String[] properties, IProgressMonitor monitor) throws CoreException;
}