DynamicTokenValue class.\r
\r
This module contains the value type of a dynamic token.\r
- \r
+\r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
- \r
+\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
-**/ \r
+**/\r
package org.tianocore.pcd.entity;\r
\r
import java.util.List;\r
\r
import org.tianocore.pcd.exception.EntityException;\r
\r
-/** This class is to descript a value type of dynamic PCD.\r
- For a dynamic or dynamicEx type PCD data, the value type can be:\r
- 1) Hii type: the value of dynamic or dynamicEx is stored into a variable.\r
- 2) Vpd type: the value of dynamic or dynamicEx is stored into somewhere set\r
- by OEM.\r
- 3) Default type: the value of dynamic or dynamicEx is stored into PCD dynamic\r
- database.\r
+/**\r
+ This class is to descript a value type of dynamic PCD.\r
+ For a dynamic or dynamicEx type PCD data, the value type can be:\r
+ 1) Hii type: the value of dynamic or dynamicEx is stored into a variable.\r
+ 2) Vpd type: the value of dynamic or dynamicEx is stored into somewhere set\r
+ by OEM.\r
+ 3) Default type: the value of dynamic or dynamicEx is stored into PCD dynamic\r
+ database.\r
**/\r
public class DynamicTokenValue {\r
///\r
/// Enumeration macro defintion for value type.\r
- /// BUGBUG: Not use upcase charater is to facility for reading. It may be changed\r
- /// in coding review.\r
- public enum VALUE_TYPE {HII_TYPE, VPD_TYPE, DEFAULT_TYPE}\r
+ ///\r
+ public static enum VALUE_TYPE {HII_TYPE, VPD_TYPE, DEFAULT_TYPE}\r
\r
+ ///\r
+ /// The value type maybe:\r
+ /// HII_TYPE: the value stored into variable area.\r
+ /// VPD_TYPE: the value stored into OEM specific area.\r
+ /// DEFAULT_TYPE: the value stored into PCD runtime database.\r
+ ///\r
public VALUE_TYPE type;\r
\r
///\r
/// ---------------------------------------------------------------------\r
- /// Following member is for HII case.\r
+ /// Following member is for HII case. The value of HII case will be put\r
+ /// into variable area in flash.\r
/// ---------------------------------------------------------------------\r
///\r
\r
\r
///\r
/// The default value for HII case.\r
- /// \r
+ ///\r
public String hiiDefaultValue;\r
\r
///\r
- /// Following member is for VPD case.\r
- /// BUGBUG: Consider 64 bit integer by using java.math.BigInteger.\r
- /// \r
+ /// ---------------------------------------------------------------------\r
+ /// Following member is for VPD case. The value of VPD case will be put into\r
+ /// some flash position pointed by OEM.\r
+ /// ---------------------------------------------------------------------\r
+ ///\r
+\r
public String vpdOffset;\r
\r
+ /// ---------------------------------------------------------------------\r
+ /// Following member is for default case. The value of default type will\r
+ /// be put into PCD runtime database.\r
+ /// ---------------------------------------------------------------------\r
+\r
+ ///\r
+ /// The default value of this PCD in default case.\r
///\r
- /// Following member is for default case.\r
- /// \r
public String value;\r
\r
- public DynamicTokenValue() {\r
- this.type = VALUE_TYPE.DEFAULT_TYPE;\r
- this.variableName = null;\r
- this.variableGuid = null;\r
- this.variableOffset = null;\r
- this.hiiDefaultValue = null;\r
-\r
- this.vpdOffset = null;\r
+ /**\r
+ Constructor function for DynamicTokenValue class.\r
\r
- this.value = null;\r
+ **/\r
+ public DynamicTokenValue() {\r
+ type = VALUE_TYPE.DEFAULT_TYPE;\r
+ variableName = null;\r
+ variableGuid = null;\r
+ variableOffset = null;\r
+ hiiDefaultValue = null;\r
+ vpdOffset = null;\r
+ value = null;\r
}\r
\r
/**\r
Set the HII case data.\r
- \r
- @param variableName\r
- @param variableGuid\r
- @param variableOffset\r
- @param hiiDefaultValue\r
- */\r
+\r
+ @param variableName The variable name\r
+ @param variableGuid The variable guid\r
+ @param variableOffset The offset of value in this variable\r
+ @param hiiDefaultValue Default value for this PCD\r
+ **/\r
public void setHiiData(List variableName,\r
UUID variableGuid,\r
String variableOffset,\r
\r
/**\r
Get the string like L"xxx" for a variable Name.\r
- \r
+\r
BUGBUG: In fact, it is not correctly, variable name should be\r
treated as unicode UINT16 array.\r
- \r
+\r
@return String\r
- */\r
- public String getStringOfVariableName() \r
+ **/\r
+ public String getStringOfVariableName()\r
throws EntityException {\r
String str;\r
int index, num;\r
- char ch;\r
+ int size;\r
\r
- str = "";\r
- for (index = 0; index < variableName.size(); index ++) {\r
+ str = "";\r
+ size = variableName.size();\r
+ for (index = 0; index < size; index++) {\r
num = Integer.decode(variableName.get(index).toString());\r
if ((num > 127 ) || (num < 0)) {\r
- throw new EntityException(String.format("variable name contains >0x80 character, now is not support!"));\r
+ throw new EntityException(String.format("The variable name contains more than 0x80 characters; this is not supported at thist time!"));\r
}\r
str += (char)num;\r
}\r
\r
/**\r
Set Vpd case data.\r
- \r
- @param vpdOffset\r
- */\r
+\r
+ @param vpdOffset the value offset the start address of OEM specific.\r
+ **/\r
public void setVpdData(String vpdOffset) {\r
this.type = VALUE_TYPE.VPD_TYPE;\r
\r
\r
/**\r
Set default case data.\r
- \r
+\r
@param value\r
- */\r
+ **/\r
public void setValue(String value) {\r
this.type = VALUE_TYPE.DEFAULT_TYPE;\r
\r
projects / mirror_edk2.git / blobdiff