core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/ISymbianSDKModifier.java
author stechong
Fri, 11 Jun 2010 12:09:52 -0500
branchC3_BUILDER_WORK
changeset 1462 b38491fd06da
parent 1434 79471fd1fd69
child 1667 352fb86872dd
permissions -rw-r--r--
More ISymbianSDK refactoring.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1434
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     1
/*
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies). 
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     3
* All rights reserved.
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     4
* This component and the accompanying materials are made available
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     6
* which accompanies this distribution, and is available
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     8
*
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     9
* Initial Contributors:
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    11
*
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    12
*/
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    13
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    14
package com.nokia.carbide.cpp.internal.api.sdk;
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    15
1462
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    16
import org.eclipse.core.runtime.IPath;
1434
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    17
import org.osgi.framework.Version;
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    18
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    19
import com.nokia.carbide.cpp.sdk.core.ISDKBuildInfo;
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    20
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    21
/**
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    22
 * Interface for modifying various attributes of Symbian OS SDK.
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    23
 *
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    24
 */
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    25
public interface ISymbianSDKModifier {
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    26
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    27
	/**
1462
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    28
	 * Add a feature supported by the SDK.
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    29
	 * @param feature supported feature
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    30
	 */
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    31
	void addSupportedFeature(Object feature);
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    32
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    33
	/**
1434
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    34
	 * Sets the build info for a particular builder.
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    35
	 * @param buildInfo build info
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    36
	 * @param builderId id string of a builder
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    37
	 */
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    38
	void setBuildInfo(ISDKBuildInfo buildInfo, String builderId);
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    39
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    40
	/**
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    41
	 * Marks the SDK as enabled or disabled.
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    42
	 * @param enable whether to enable or disable the SDK
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    43
	 */
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    44
	void setEnabled(boolean enable);
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    45
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    46
	/**
1462
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    47
	 * Set the absolute path to the epoc32 directory of this SDK.
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    48
	 * @param epocRoot absolute path to the epoc32 directory
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    49
	 */
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    50
	void setEPOCROOT(String epocRoot);
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    51
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    52
	/**
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    53
	 * Sets display name of a SDK. This is the com.vendor.family identifier.
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    54
	 * @param name SDK display name
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    55
	 */
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    56
	void setName(String name);
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    57
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    58
	/**
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    59
	 * Sets the OS version string of a SDK.
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    60
	 * @param osVer OS version
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    61
	 */
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    62
	public void setOSVersion(Version osVer);
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    63
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    64
	/**
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    65
	 * Sets the prefix file for a particular builder.
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    66
	 * @param prefixFile path of prefix file
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    67
	 * @param builderId id string of a builder
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    68
	 */
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    69
	void setPrefixFile(IPath prefixFile, String builderId);
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    70
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    71
	/**
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    72
	 * Sets the SDK version string of a SDK.
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    73
	 * @param sdkVers SDK version
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    74
	 */
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    75
	void setSDKVersion(Version sdkVers);
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    76
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    77
	/**
1434
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    78
	 * Sets the unique id of a SDK.
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    79
	 * @param id id string of a SDK
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    80
	 */
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    81
	void setUniqueId(String id);
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    82
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    83
}