frameworkplugins/com.nokia.s60tools.util/src/com/nokia/s60tools/util/sourcecode/SourceFileLocation.java
author dpodwall
Tue, 12 Jan 2010 13:17:53 -0600
changeset 0 61163b28edca
permissions -rw-r--r--
initial EPL conversion
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     1
/*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     2
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     3
* All rights reserved.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     4
* This component and the accompanying materials are made available
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     6
* which accompanies this distribution, and is available
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     8
*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     9
* Initial Contributors:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    11
*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    12
* Contributors:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    13
*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    14
* Description:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    15
*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    16
*/
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    17
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    18
package com.nokia.s60tools.util.sourcecode;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    19
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    20
/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    21
 * Class for holding source file information.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    22
 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    23
public class SourceFileLocation {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    24
	
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    25
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    26
	 * Folder name constant for release directory
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    27
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    28
	public static final String RELEASE_FOLDER_NAME = "RELEASE"; //$NON-NLS-1$
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    29
	
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    30
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    31
	 * Folder name constant for epoc32
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    32
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    33
	public static final String EPOC32_FOLDER_NAME = "epoc32"; //$NON-NLS-1$
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    34
	
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    35
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    36
	 * Value for method offset in source file if offset was not found or is not set.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    37
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    38
	public static final int OFFSET_NOT_FOUND = -1;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    39
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    40
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    41
	 * Ordinal
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    42
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    43
	private String ordinal = null;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    44
	
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    45
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    46
	 * Name of the method
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    47
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    48
	private String methodName = null;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    49
	
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    50
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    51
	 * Source file location
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    52
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    53
	private String sourceFileLocation = null;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    54
	
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    55
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    56
	 * Name of the DLL where method is exported
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    57
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    58
	private String dllName = null;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    59
	
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    60
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    61
	 * Name of the object file, where method is exported
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    62
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    63
	private String objectName = null;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    64
	
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    65
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    66
	 * Method address
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    67
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    68
	private String methodAddress = null;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    69
	
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    70
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    71
	 * Method line offset. 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    72
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    73
	private int methodLineOffset = OFFSET_NOT_FOUND;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    74
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    75
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    76
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    77
	 * Gets method ordinal
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    78
	 * @return the ordinal
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    79
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    80
	public String getOrdinal() {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    81
		return ordinal;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    82
	}
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    83
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    84
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    85
	 * Sets method ordinal
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    86
	 * @param ordinal the ordinal to set
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    87
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    88
	public void setOrdinal(String ordinal) {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    89
		this.ordinal = ordinal;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    90
	}
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    91
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    92
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    93
	 * Gets method name
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    94
	 * @return the methodName
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    95
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    96
	public String getMethodName() {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    97
		return methodName;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    98
	}
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    99
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   100
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   101
	 * Sets method name
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   102
	 * @param methodName the methodName to set
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   103
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   104
	public void setMethodName(String methodName) {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   105
		this.methodName = methodName;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   106
	}
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   107
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   108
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   109
	 * Gets source file location
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   110
	 * @return the sourceFileLocation in absolute path.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   111
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   112
	public String getSourceFileLocation() {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   113
		return sourceFileLocation;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   114
	}
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   115
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   116
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   117
	 * Sets source file location
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   118
	 * @param sourceFileLocation in absolute format.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   119
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   120
	public void setSourceFileLocation(String sourceFileLocation) {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   121
		this.sourceFileLocation = sourceFileLocation;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   122
	}
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   123
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   124
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   125
	 * Gets DLL name
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   126
	 * @return the dllName
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   127
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   128
	public String getDllName() {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   129
		return dllName;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   130
	}
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   131
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   132
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   133
	 * Sets DLL name
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   134
	 * @param dllName the dllName to set
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   135
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   136
	public void setDllName(String dllName) {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   137
		this.dllName = dllName;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   138
	}
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   139
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   140
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   141
	 * Gets object name
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   142
	 * @return the objectName
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   143
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   144
	public String getObjectName() {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   145
		return objectName;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   146
	}
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   147
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   148
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   149
	 * Sets object name
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   150
	 * @param objectName the objectName to set
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   151
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   152
	public void setObjectName(String objectName) {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   153
		this.objectName = objectName;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   154
	}
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   155
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   156
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   157
	 * Sets the address of the method
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   158
	 * @param methodAddress
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   159
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   160
	public void setMethodAddress(String methodAddress) {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   161
		this.methodAddress  = methodAddress;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   162
	}
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   163
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   164
	 * Get method address
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   165
	 * @return the address of the method
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   166
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   167
	public String getMethodAddress() {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   168
		return methodAddress;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   169
	}
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   170
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   171
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   172
	 * Gets method offset
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   173
	 * @return the methodLineOffset or 0 if not known or set.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   174
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   175
	public int getMethodOffset() {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   176
		return methodLineOffset;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   177
	}
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   178
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   179
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   180
	 * Sets method offset
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   181
	 * @param methodLineOffset the methodLineOffset to set
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   182
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   183
	public void setMethodOffset(int methodLineOffset) {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   184
		this.methodLineOffset = methodLineOffset;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   185
	}
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
   186
}