javaruntimes/jvmargmodifier/default/inc/jvmargsmodifier.h
branchRCL_3
changeset 14 04becd199f91
equal deleted inserted replaced
13:f5050f1da672 14:04becd199f91
       
     1 /*
       
     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  A method for modifying the JVM args.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef JVMARGSMODIFIER_H
       
    20 #define JVMARGSMODIFIER_H
       
    21 
       
    22 #include "javaoslayer.h"
       
    23 
       
    24 #include <string>
       
    25 #include <list>
       
    26 
       
    27 namespace java // codescanner::namespace
       
    28 {
       
    29 
       
    30 namespace runtime // codescanner::namespace
       
    31 {
       
    32 
       
    33 /**
       
    34  * Provides a way for modifying the JVM arguments from some external
       
    35  * source. In the rom there will be an empty implementation of this method
       
    36  * which can be overridden by eclipsing javajvmargsmodifier.dll having this
       
    37  * method in ordinal 1. The modifier has full control of each argument passed
       
    38  * to the JVM. The arguments are divided into two categories - the arguments
       
    39  * for the JVM and the arguments for the application. Both are modifyable by
       
    40  * the external source modifier.
       
    41  * @param identifier An idetifier that can be used to distinguish different
       
    42  *                   runtimes.
       
    43  * @param jvmArgs    A list of Jvm args. This list contains all the arguments
       
    44  *                   before the main class.
       
    45  * @param applicationAndArgs A list that contains the main class as a first
       
    46  *                           item in the list. The leading item(s) in the
       
    47  *                           list are the arguments for the main method of
       
    48  *                           the main class.
       
    49  */
       
    50 OS_IMPORT void modifyJvmArguments(const std::wstring& identifier,
       
    51                                   std::list<std::wstring>& jvmArgs,
       
    52                                   std::list<std::wstring>& applicationAndArgs);
       
    53 } // end namespace runtime
       
    54 } // end namespace java
       
    55 
       
    56 
       
    57 #endif // JVMARGSMODIFIER_H