C # From Java Rob Miles Edition 3.1 2008-2009 Department of Computer Science University of Hull Contents Contents 2 Introduction 4 Big Project Blues 4 What do I do for development tools? 4 How do I break a system up into chunks? 4 Where does the Main method go in C#? 5 What is the Automatic Conversion tool like? 5 All Quiet in the Studio 5 How do I set a bookmark in the source using Visual Studio? 5 How do I get my source code laid out for me? 5 Why do class members start with capital letters? 5 How do I create a new class in a Visual Studio Project? 6 How do I put the documentation comments into my source 6 How do I get full screen source code edit in Visual Studio? 7 How do I link a C# solution? 7 How do I make a distribution of my program? 7 Programming Matters 8 How do I store the date and time? 8 How do I get the current date and time? 8 How do I copy a DateTime value? 8 How do I do date comparison? 8 How do I get a random number? 8 How do I terminate the program with extreme prejudice? 9 Through a Window darkly 9 How do I create a modal window? 9 How do I stop a window from closing? 10 How do I ask a user yes or no? 11 How do I give a title to a Windows Form? 11 Where have the layout managers gone? 11 Class Acts 12 What is the relationship between const, final and static? 12 Where has the Vector class gone? 12 How do I use enum in C#? 12 How do I call a constructor in a parent class? 13 How do I call another constructor in the same class? 13 Where have implements/extends gone? 13 Why can’t the compiler find my implementation of an interface? 14 Why won’t my inner classes work properly? 14 Why won’t my overriding method run? 15 How do I use delegates? 16 How do I use properties? 18 How do I create an Abstract Property? 19 How do I serialize a class? 19 How do I mark a member as not to be saved by serialisation? 20 C# from Java © Rob Miles 2009 3 Why does my serialialization not work? 20 How do I find out what classes I’ve got? 21 How do I make an instance of one if the classes I’ve found? 22 How do I call a method in a type? 23 Neat Stuff 23 Good Dragging 23 Help Completion 24 © Rob Miles 2009 Department of Computer Science, The University of Hull. All rights reserved. No reproduction, copy or transmission of this publication may be made without written permission. The author can be contacted at: The Department of Computer Science, Robert Blackburn Building The University of Hull, Cottingham Road HULL HU6 7RX UK Email: rob@robmiles.com Blog: www.robmiles.com If you find a mistake in the text please report the error to foundamistake@robmiles.com and I will take a look. Vsn. 3.1 1/30/2009 9:45:00 AM C# from Java © Rob Miles 2009 4 Introduction These notes should help you convert a program from Java to C#. I assume that the reader is an experienced Java programmer. The notes also document decisions which I have made which may or may not be sensible. I’ve written them in FAQ form as that seems to be the most useful way to present the information. I hope that those that know less than me will find them useful. I hope that those who know more than me won’t find too many things wrong… Big Project Blues This section deals with project management/creation issues. We have a fairly large project, in this case around forty or so class files arranged in a number of packages. It might not be big to you, but it is to us. What do I do for development tools? One useful addition to the Visual Studio range is Visual Studio Express, which is presently available for free. It involves a download of around 300 MB, but it is fully functional. It is of particular interest to students, who could perform all the coursework on our first year with this product. For the first part of the year I advise students to make use of the command line compiler, and edit their programs in text files using notepad. There are two reasons for this. The first is that the complexity of the Visual Studio environment and the need to create a project can be daunting for a newcomer to programming. The second reason is that I want the students to have a solid understanding of the compile/execute process, and the fact that the compiler is a program that converts text based source code into an executable version. Seeing the .exe files is a very good way of making this point. In Visual Studio it is not immediately clear where the program file runs from, and this can be confusing. How do I break a system up into chunks? My friend Kevin, who knows about these things, says that you break your projects up by using, er, projects. A project is a subcomponent of a solution. A project can be placed in a separate directory with all its class files. Visual Studio solution can contain lots of projects. The output of a project is an assembly. This is analogous to a Java Archive (jar) file in that it can contain classes and other resources (forms, bitmaps, sound samples etc). An assembly can be either an executable program (.exe) or a Dynamic Link Library (.dll). A dll assembly just contains classes that can be picked up by the master asembly in your solution which produces the executable. This is the class that contains the Main method (see below). Don't confuse these files with old school .exe and .dll files which have been part of Windows for years. These must be processed by the .NET runtime system which performs Just In Time compilation on them to make them run, just as the Java Virtual Machine (JVM) runs Java class files. Fortunately most versions of Windows XP and all versions of Vista now have the .NET runtimes built in. C# from Java © Rob Miles 2009 5 Where does the Main method go in C#? Java doesn't make a distinction between library files and executable files, a java source file compiles into a class file. A familiar Java trick is the inclusion of a main method in all classes. This provides a way of performing isolated tests on each class simply by running it. Some Java programmers like this, others loath it. C# and Visual Studio are quite unambiguous on this one. Only a project which produces a .exe file is allowed to have a Main method (which starts with a capital letter). Unlike Java you can use one of a number of different Main method signatures, depending on whether or not you are interested in the result produced by your program or want to feed it parameters. If your solution contains multiple project that produce executables (see above) each of the projects can contain a Main method which will be entered when the program starts. You can nominate one of the projects in the solution as the one which is started by Visual Studio when you press the run button. This means that you can have a set of business classes and then multiple executable classes (a CLI version, a GUI version and perhaps a test harness) all in the same solution, and pick which one you want to work with. What is the Automatic Conversion tool like? I’ve had a brief fling with the automatic conversion system. My advice is don’t bother unless you are after something very quick and very dirty, and you happen to have written the code in Visual J++; neither of which apply to me. My gut feeling is that if you want to make proper use of all that C# offers you will need to convert the application by hand. The good news is that this will probably result in smaller, faster and clearer code. The bad news is that you have to do it. All Quiet in the Studio This section deals with how you use Visual Studio (a really nice tool) to write your programs. How do I set a bookmark in the source using Visual Studio? You set a bookmark by using the sequence CTRL+K CTRL+K (that is CTRL+K twice). This is sort of like old style Borland C (or Wordstar for very old people) except that the second character needs to have control held down as well. This toggles the bookmark on and off. You jump to a bookmark by using CTRL+K CTRL+N. If you have lots of bookmarks this sequence moves you to the next one in the sequence. How do I get my source code laid out for me? Visual Studio makes an attempt at laying out your code, but it sometimes gets mixed up. If you want to force it to lay the code out for you the commands are: CTRL+A (select all the text in the edit window) CTRL+K CTRL+F Why do class members start with capital letters? Java programmers will love this. The convention in C# is that public members of classes have a capital initial letter in their name. This goes directly against the Java C# from Java © Rob Miles 2009 6 convention. Only parameters, local variables and private members have lower case characters as the first letters of their identifiers. How do I create a new class in a Visual Studio Project? Visual Studio will let you make a new class but, unlike Java, it doesn’t have a strict mapping between class names and filenames. Indeed you can put classes from several different namespaces (the C# equivalent for packages – almost) in files of any name. I like to have the names of the classes match the files (which is probably a bit sad) and also to have a directory hierarchy which matches the namespace one. However, C# does not insist on this, and lately I’ve began to relax about this and put files where they make the most sense. How do I put the documentation comments into my source Java has Javadoc. C# doesn’t. C# has a commenting system which is very similar, where you put keys into the source code which are picked up and used to generate program documentation. Most Java development environments have a neat way of creating the comment structures which drive the Java documentation process. Visual Studio didn’t seem to have any of this until I moaned to a Microsoft guy (step forward George Conard) about this terrible limitation. Then he showed me how to do it. It is very simple, very easy to use, and very neat. Just above the start of your method press forward slash three times: /// <summary> /// /// </summary> /// <param name=”value”></param> /// <returns></returns> public int AddOneTo ( int value ) { return value + 1; } All the comments are generated automatically. All you have to do now is fill in the text in the empty spaces to produce the program documentation. Note how you can enter a description of the method, information about the parameters and also the return information just by filling in text in the appropriate positions. Note also that when you do this the very nice IDE puts in leading /// sequences to make sure that your code is a proper comment. One thing to remember is that this automatic behaviour only works if Visual Studio is working with a project. If you just have source file open you will find that /// doesn't do anything. To get the actual documentation you can use a tool like ndoc: http://ndoc.sourceforge.net/ to build the web pages. C# from Java © Rob Miles 2009 7 How do I get full screen source code edit in Visual Studio? You can select this from the view menu, but I use ALT+SHIFT+ENTER. You can do most of your work (including compiling and debugging) using this nice large view, but it is best if you make sure that all the sources files you want to use are open before you switch to this view because opening extra ones is a bit of a pain. How do I link a C# solution? With Java you don’t have to think about linking. If the compiler is happy your program will work (leaving aside potential nasties with the class path). In C# and Visual Studio things are different. You have to make sure that the compiler can find stuff. You do this by using using; for example if you want to use the Forms library in a class you have to put: using System.Windows.Forms; - at the top. This is directly analogous to Java import. However, unlike Java you also have to tell the Visual Studio project that you are using this set of resources. To do this you go into the Solution Explorer and right click on the References leaf just underneath the tree entry for the project that you want to use the particular assembly. Then select Add Reference from the context menu which pops up and pick up your reference. You can add references to .NET resources, assemblies in your project or COM objects. A sign of problems with your references is when the auto completion stops working. This will be followed by a whole bunch of build errors. If your solution makes use of multiple assemblies these will be referenced by the executable and you must make sure that all the assemblies are distributed, otherwise your program will file just like a Java application would if it was shipped with some class files missing. How do I make a distribution of my program? You need to add a project to do this for you. Open the Solution Explorer and right click on the Solution item at the very top. Select Add and then Add New Project when it opens up. From the New Project dialogue box select the tree item “Setup and Deployment Projects” and then pick Setup Project. Give the project a name and sensible location. You can now build a setup, but it won’t do anything (I actually did this – oh how I laughed). You need to add some files to the setup project to get it to work. Right click on the project in the Solution Explorer and select add from the Context Menu and then move on to Project Output. This means that you will actually get your program deployed. To build the setup you need to right click on the project and select build. Note that the build behaviour is controlled by the Release/Debut selection in main window. The output is actually placed in the directory you specified for the project, with separate directories for build and release. You can copy the MSI file onto another machine and run it to install the program. You don’t get a shortcut for the desktop or anything, but the program can be made to run from the appropriate Program Files directory. C# from Java © Rob Miles 2009 8 Programming Matters These bits deal with flotsam and jetsam which I’ve picked up just writing the code. How do I store the date and time? The Date class in Java has been replaced with System.DateTime. The good news is that this class is actually able to perform date arithmetic for you. Again, the bad news is that you have to perform the conversion. How do I get the current date and time? You can use the static Now property of the System.DateTime class: CurrentTime.Text = System.DateTime.Now.ToLongTimeString(); How do I copy a DateTime value? You need to convert a date into a Long value of ticks which can be passed into the constructor to make a DateTime instance: NewTime = new System.DateTime(OldTime.Ticks); How do I do date comparison? If you subtract one System.DateTime instance from another you get an instance of the System.TimeSpan class as a result. You can compare these directly to find out if a given time has elapsed: // initialise our timer TStart = new System.DateTime(System.DateTime.Now.Ticks); // let some time go by System.TimeSpan WarningLength = new System.TimeSpan(0,9,0); System.TimeSpan CurrentLength = System.DateTime.Now - TStart; if (CurrentLength > WarningLength) { // get here if more than 9 minutes have gone by } The above code will obey the line shown when more than 9 minutes have elapsed. The WarningLength timespan has been set to 0 hours, 9 minutes and 0 seconds. How do I get a random number? Random numbers are quite easy. You have to make an instance of a System.Random object and then use that to produce numbers for you: System.Random r = new System.Random(); C# from Java © Rob Miles 2009 9 The constructor for this class is overloaded. There is a version you can call with an integer seed if you always want the same pseudo-random sequence. If you call the version with no parameters you get the generator seeded from the system clock. Once you have your random object you can ask it to give you random numbers: int coin = r.Next(1); // give me a value between 0 and 1 int diceSpots = r.Next(1,7) ; // give me a value between 1 and 6 int big = r.Next() ; // give me a value between 0 and maxint Note that in the call of the Next method the upper limit is exclusive, in that random numbers produced will not include that value. There are also methods which can give you an array full of random numbers, and also floating point numbers. Remember though that these random number sequences are not cryptographically strong, but they are fine for things like games. For heavy duty randomness you should take a look at the RandomNumberGenerator class in the System.Security.Cryptography namespace. How do I terminate the program with extreme prejudice? Sometimes your program just has to die. To perform such a mercy killing Java has System.exit(n) where n is the last message value from your dying program. C# has something virtually identical: System.Environment.Exit(0); The parameter given to the Exit method will be passed back to the operating system. Through a Window darkly These are items to do with the windowing output. How do I create a modal window? Modal windows are the useful ones which stop everything else while the user fills in a form. You determine whether or not a window is modal by the way that you show it. Assuming that you have an instance of a Form called MyForm from System.Windows.Forms you can create a modal version by going: MyForm.ShowDialog(); Or MyForm.ShowDialog(ParentForm); - if you have a reference to the parent form. If you want a Form which is not modal, and therefore harder to program, you can use the Show method: MyForm.Show (); C# from Java © Rob Miles 2009 10 How do I stop a window from closing? Sometimes you want to get control as a window is being closed, for example you may want to insist that the user saves their file before exiting from their edit. Alternatively you may want to stop the user from closing a form if they have not done some action. In C# you do this by adding a delegate to the closing action of the form: AuthorForm.Closing += new System.ComponentModel.CancelEventHandler(CloseHit); AuthorForm is a reference to a class derived from System.Windows.Forms.Form. The class containing this line of code also contains a method called CloseHit: private void CloseHit (object sender, System.ComponentModel.CancelEventArgs e) { if (AuthorCompletedOK) { e.Cancel=false; return; } // not saved OK - must ask if it is OK to shut down string message = "OK to shut down?" ; string caption = "Authoring"; MessageBoxButtons buttons = MessageBoxButtons.YesNo; DialogResult result; result = MessageBox.Show(message, caption, buttons); if (result == DialogResult.No) { AuthorForm.Show(); // because my window is modal e.Cancel = true; } else { e.Cancel = false; } } I signal that I don’t want the close to complete by setting to true the Cancel property of the CancelEventArgs instance which is passed in to the method call. Note that I also need to call a Show of the form. I need to do this because my AuthorForm happens to be a modal dialog, and these are hidden just before they are closed. If it is OK to close the form I set the Cancel property of the CancelEventArgs instance to false. Note that my class contains a bool flag called AuthorCompletedOK. This is set to true by me if it is OK to close the window. I needed to do this because the behaviour of the closing event is slightly different from that in Java Swing. This closing event will be fired when the form closes, irrespective of whether this is a [...]... the Vector class gone? There is no Vector collection class in C# This means that you have to use an ArrayList instead One nice thing about C# collections is that they can be indexed This means that I can add subscripts to an instance of a collection to get particular elements out of it The latest version of C# has generics, which means that you can create a typesafe List of references to any class How... public delegate bool CheckResult ( string newValue ); Now I have a delegate type called CheckResult which I can use to create references to methods which fit the signature (and no others) Note that I have made this type public, so that I can create these outside of the class In other words I can do things like: CheckResult CheckMethod; Note I haven’t got a method yet, just a delegate reference which can... the class private class EditorClass : Form { // reference to what we are editing DataClass ThisClass; public EditorClass ( DataClass thisClass ) { // copy a reference to the enclosing instance this.ThisClass = thisClass; // use it to get my properties to change ThisClass.MyData = "new value"; } } // the edit method for my class public void DoEdit () { // pass a reference to myself into the edit class... do not function as references themselves Now I can call the method which the delegate presently refers to by simply calling it: CheckMethod ( "Fred"); This would result in a call to EmptyStringCheck if the assignment had been performed Big fun comes when I use a delegate as a parameter to a method call: C# from Java © Rob Miles 2009 16 public DoStuffThatNeedsACheckMethod( CheckResult CheckMethod )... we need to check them: if (CheckMethod (thingWeWorkWith ) ) { // pass the test } } We can pass into the method a delegate which specifies the thing that needs to be invoked to perform the verification: CheckResult MyCheckMethod; // assign MyCheckMethod to the desired method DoStuffThatNeedsACheckMethod (MyCheckMethod); You can have lots of method calls attached to a single delegate You can use the... (which has been suitably overridden) to add new ones: CheckMethod += new CheckResult (InvalidStringCheck); Now when the delegate is invoked both InvalidStringCheck and EmptyStringCheck will be called If you don’t like overloaded operators you can use If you want to remove a method from a delegate you use -= operator: CheckMethod -= new CheckResult (EmptyStringCheck); This would mean that only the call... types in a collection which I can then iterate through For each of the types that I started with I check to see if I can assign my drawing type to it If the answer is yes I have a match I have to also check to make sure that the type is not abstract (since I want to construct these beasts) At the end of the loop I have a collection which contains references to the types that are available: foreach ( System.Type... factory method static for reasons which are too complicated to go into here The second parameter is an array of objects which constitute the parameters to the method call In the case of my example code I’m passing a reference to the container which is going to contain the thing that I am making Of course if you provide a list of objects which does not match the method signature you will get an exception... there was no way of doing my edit trick The answer is very simple; just pass the constructor of your inner class a reference to an instance of the enclosing one Then twiddle with the contents of this reference It is neater because it means that the code is much clearer Hopefully this code example below will make it much clearer: C# from Java © Rob Miles 2009 14 class DataClass { // lots of private members... serializable interface will also flag all the children, in C# you seem to have to add the attribute to all the child classes as well as the parent before the save process works correctly C# from Java © Rob Miles 2009 20 How do I find out what classes I’ve got? I like writing code which automatically finds out what classes are around and then configures itself accordingly I regard this as a constructive form . Class Acts 12 What is the relationship between const, final and static? 12 Where has the Vector class gone? 12 How do I use enum in C# ? 12 How do I call a constructor in a parent class? 13 How. “Come back linking, all is forgiven” for more details. C# from Java © Rob Miles 2009 13 How do I call a constructor in a parent class? The protocol for calling a super constructor (i.e. calling. particular assembly. Then select Add Reference from the context menu which pops up and pick up your reference. You can add references to .NET resources, assemblies in your project or COM objects.