2010-03-30 Jb Evain <jbevain@novell.com>
[mcs.git] / docs / ecma334 / 8.7.2.xml
blobc25fbfca280576e2fb0f37e63ff1368fb9b6bc22
1 <?xml version="1.0"?>
2 <clause number="8.7.2" title="Fields" informative="true">
3   <paragraph>A field is a member that represents a variable associated with an object or class. The example <code_example><![CDATA[
4 class Color  
5 {  
6    internal ushort redPart;  
7    internal ushort bluePart;  
8    internal ushort greenPart;  
9    public Color(ushort red, ushort blue, ushort green) {  
10       redPart = red;  
11       bluePart = blue;  
12       greenPart = green;  
13    }  
14    public static Color Red = new Color(0xFF, 0, 0);  
15    public static Color Blue = new Color(0, 0xFF, 0);  
16    public static Color Green = new Color(0, 0, 0xFF);  
17    public static Color White = new Color(0xFF, 0xFF, 0xFF);  
18 }  
19 ]]></code_example>shows a Color class that has internal instance fields named redPart, bluePart, and greenPart, and static fields named Red, Blue, Green, and White The use of static fields in this manner is not ideal. The fields are initialized at some point before they are used, but after this initialization there is nothing to stop a client from changing them. Such a modification could cause unpredictable errors in other programs that use Color and assume that the values do not change. Readonly fields can be used to prevent such problems. Assignments to a readonly field can only occur as part of the declaration, or in an instance constructor or static constructor in the same class. A static readonly field can be assigned in a static constructor, and a non-static readonly field can be assigned in an instance constructor. Thus, the Color class can be enhanced by adding the modifier readonly to the static fields: <code_example><![CDATA[
20 class Color  
21 {  
22    internal ushort redPart;  
23    internal ushort bluePart;  
24    internal ushort greenPart;  
25    public Color(ushort red, ushort blue, ushort green) {  
26       redPart = red;  
27       bluePart = blue;  
28       greenPart = green;  
29    }  
30    public static readonly Color Red = new Color(0xFF, 0, 0);  
31    public static readonly Color Blue = new Color(0, 0xFF, 0);  
32    public static readonly Color Green = new Color(0, 0, 0xFF);  
33    public static readonly Color White = new Color(0xFF, 0xFF, 0xFF);  
34 }  
35 ]]></code_example></paragraph>
36 </clause>