r/org.eclipse.statet.r.core/src/org/eclipse/statet/r/core/RProject.java

/*=============================================================================#
 # Copyright (c) 2014, 2019 Stephan Wahlbrink and others.
 # 
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License 2.0 which is available at
 # https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 # which is available at https://www.apache.org/licenses/LICENSE-2.0.
 # 
 # SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 # 
 # Contributors:
 #     Stephan Wahlbrink <sw@wahlbrink.eu> - initial API and implementation
 #=============================================================================*/

package org.eclipse.statet.r.core;

import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.IPath;

import org.eclipse.statet.jcommons.collections.ImList;
import org.eclipse.statet.jcommons.lang.NonNullByDefault;
import org.eclipse.statet.jcommons.lang.Nullable;

import org.eclipse.statet.ecommons.preferences.core.Preference;
import org.eclipse.statet.ecommons.preferences.core.Preference.NullableStringPref;
import org.eclipse.statet.ecommons.preferences.core.PreferenceAccess;

import org.eclipse.statet.internal.r.core.RProjectNature;
import org.eclipse.statet.ltk.buildpaths.core.IBuildpathElement;


@NonNullByDefault
public interface RProject extends PreferenceAccess, IRCoreAccess {
	
	
	String BUILD_PREF_QUALIFIER= RCore.BUNDLE_ID + "/build/RProject"; //$NON-NLS-1$
	
	Preference<@Nullable String> PKG_BASE_FOLDER_PATH_PREF= new NullableStringPref(BUILD_PREF_QUALIFIER,
			RProjectNature.RPKG_ROOT_FOLDER_PATH_KEY );
	
	Preference<@Nullable String> RENV_CODE_PREF= new NullableStringPref(BUILD_PREF_QUALIFIER,
			RProjectNature.RENV_CODE_KEY );
	
	
	/**
	 * Returns the resource handle of the project.
	 * 
	 * @return the resource
	 */
	IProject getProject();
	
	
	ImList<IBuildpathElement> getRawBuildpath();
	
	
	/**
	 * Returns the name of the R package.
	 * 
	 * @return the name
	 */
	@Nullable String getPkgName();
	
	/**
	 * Returns the base path of the R package.
	 * 
	 * @return the full path
	 */
	@Nullable IPath getPkgRootPath();
	
}