builder/com.nokia.carbide.cdt.builder.test/src/com/nokia/carbide/cdt/builder/test/sandbox/ISBSv2ConfigData.java
author timkelly
Fri, 21 May 2010 12:08:04 -0500
changeset 1386 ea54f91365dc
parent 1380 c70ff7f19887
permissions -rw-r--r--
updated APIs after first review. Added comments to all API for proposed behaviour
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1386
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
     1
/*
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
     3
* All rights reserved.
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
     4
* This component and the accompanying materials are made available
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
     6
* which accompanies this distribution, and is available
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
     8
*
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
     9
* Initial Contributors:
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    10
* Nokia Corporation - initial contribution.
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    11
*
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    12
* Contributors:
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    13
*
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    14
* Description: 
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    15
* Test the BldInfViewPathHelper class.
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    16
*
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    17
*/
1379
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    18
package com.nokia.carbide.cdt.builder.test.sandbox;
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    19
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    20
import com.nokia.carbide.cpp.sdk.core.ISymbianSDK;
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    21
1386
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    22
/** 
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    23
 * Data that describes the meaning of a single build configuration, as discovered by SBS
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    24
 *  
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    25
 *  @noimplement
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    26
 */
1379
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    27
public interface ISBSv2ConfigData {
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    28
1386
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    29
	/**
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    30
	 * Get the usable SBS build alias that can be used for the -c parameter
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    31
	 * @return the unique build alias
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    32
	 */
1379
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    33
	String getBuildAlias();
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    34
	
1386
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    35
	/**
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    36
	 * Get the meaning (aka dotted name, component name) fo the build alias. 
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    37
	 * Can also be used as a -c argument in SBS
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    38
	 * @return the meaning
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    39
	 */
1379
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    40
	String getMeaning();
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    41
	
1386
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    42
	/**
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    43
	 * Get the directory for a given SDK where binaries are output
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    44
	 * @param sdk - use null if for base configuration
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    45
	 * @return the portable OS string starting from /epoc32/
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    46
	 */
1380
c70ff7f19887 more api changes for sbs query config design
timkelly
parents: 1379
diff changeset
    47
	String getReleaseDirectory(ISymbianSDK sdk);
1379
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    48
	
1386
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    49
	/** 
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    50
	 * TODO: This API is not yet defined.
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    51
	 * @param sdk
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    52
	 * @return
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    53
	 */
1380
c70ff7f19887 more api changes for sbs query config design
timkelly
parents: 1379
diff changeset
    54
	ISBSv2ConfigPreprocessorInfo getBuildData(ISymbianSDK sdk);
1379
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    55
	
1386
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    56
	/**
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    57
	 * Get the name of the folder where executable binaries are written (typically 'debug' or 'release')
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    58
	 * @param sdk - use null for base configuration
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    59
	 * @return string of folder name
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    60
	 */
1380
c70ff7f19887 more api changes for sbs query config design
timkelly
parents: 1379
diff changeset
    61
	String getTraditionalTarget(ISymbianSDK sdk);
1379
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    62
	
1386
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    63
	/**
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    64
	 * Get the name of the folder where executable binaries are written (component before the target)
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    65
	 * @param sdk - use null for base configuration
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    66
	 * @return string of folder name
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    67
	 */
1380
c70ff7f19887 more api changes for sbs query config design
timkelly
parents: 1379
diff changeset
    68
	String getTraditionalPlatform(ISymbianSDK sdk);
1379
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    69
	
1386
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    70
	/**
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    71
	 * Get the SDK for which this configuration was qeuried.
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    72
	 * @return the SDK, or null if it's a base sbs configuration
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    73
	 */
ea54f91365dc updated APIs after first review. Added comments to all API for proposed behaviour
timkelly
parents: 1380
diff changeset
    74
	ISymbianSDK getSupportingSDK();
1379
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    75
	
1fd5209125b8 first cut of APIs for Raptor config query
timkelly
parents:
diff changeset
    76
}